MarkupLanguage


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.markup;
17  
18  import org.apache.avalon.framework.component.Component;
19  import org.apache.cocoon.components.language.programming.ProgrammingLanguage;
20  import org.apache.excalibur.source.Source;
21  
22  /**
23   * This interface defines a markup language whose SAX producer's instance are to
24   * be translated into an executable program capable or transforming the original
25   * document augmenting it with dynamic content
26   *
27   * @author <a HREF="mailto:ricardo@apache.org">Ricardo Rocha</a>
28   * @author <a HREF="mailto:vgritsenko@apache.org">Vadim Gritsenko</a>
29   * @version CVS $Id: MarkupLanguage.java 30932 2004-07-29 17:35:38Z vgritsenko $
30   */
31  public interface MarkupLanguage extends Component {
32  
33      String   ROLE = MarkupLanguage.class.getName();
34  
35      /**
36       * Return the input document's encoding or <code>null</code> if it is the
37       * platform's default encoding.
38       * This method should be called after <code>generateCode<code> method.
39       *
40       * @return The input document's encoding
41       */
42      String   getEncoding();
43  
44      /**
45       * Generate source code from the input source for the target
46       * <code>ProgrammingLanguage</code>.
47       *
48       * @param source The source document
49       * @param filename The input document's original filename
50       * @param programmingLanguage The target programming language
51       * @return The generated source code
52       * @exception Exception If an error occurs during code generation
53       */
54      String   generateCode(Source source,
55                          String   filename,
56                          ProgrammingLanguage programmingLanguage)
57              throws Exception  ;
58  }
59
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags