CodeFormatter


1   /*
2    * Copyright 1999-2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.apache.cocoon.components.language.programming;
17  
18  /**
19   * This interface defines source beautifying formatting
20   *
21   * @author <a HREF="mailto:ricardo@apache.org">Ricardo Rocha</a>
22   * @version CVS $Id: CodeFormatter.java 30932 2004-07-29 17:35:38Z vgritsenko $
23   */
24  public interface CodeFormatter {
25    /**
26     * Format and beautify a <code>String</code> containing source code
27     *
28     * @param code The input source code
29     * @param encoding The encoding used for constant strings embedded in the
30     * source code
31     * @return The formatted source code
32     */
33    String   format(String   code, String   encoding);
34  }
35

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags