01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.components.language.programming;
18:
19: /**
20: * This interface defines source beautifying formatting
21: *
22: * @author <a href="mailto:ricardo@apache.org">Ricardo Rocha</a>
23: * @version CVS $Id: CodeFormatter.java 433543 2006-08-22 06:22:54Z crossley $
24: */
25: public interface CodeFormatter {
26: /**
27: * Format and beautify a <code>String</code> containing source code
28: *
29: * @param code The input source code
30: * @param encoding The encoding used for constant strings embedded in the
31: * source code
32: * @return The formatted source code
33: */
34: String format(String code, String encoding);
35: }
|