View Javadoc

1   package org.apache.velocity.site.doxia.runner;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.io.Reader;
23  
24  import org.apache.velocity.site.doxia.util.VelocityDoxiaRendererException;
25  
26  public interface VelocityRunner
27  {
28  
29      /** Plexus Role Definition */
30      String ROLE = VelocityRunner.class.getName();
31  
32      String PARSE_METHOD = "parseVelocity";
33  
34      Class[] PARSE_METHOD_SIGNATURE = new Class[] { Reader.class };
35  
36      void initVelocity() throws VelocityDoxiaRendererException;
37  
38      String parseVelocity(final Reader reader) throws Exception;
39  }