View Javadoc

1   /**
2    * Copyright (C) 2005-2009 Alfresco Software Limited.
3    *
4    * This file is part of the Spring Surf Extension project.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *  http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  package org.springframework.extensions.surf.core.processor;
20  
21  /**
22   * Interface for Proccessor classes - such as Template or Scripting Processors.
23   * 
24   * @author Roy Wetherall
25   */
26  public interface Processor
27  {
28      /**
29       * Get the name of the processor
30       * 
31       * @return  the name of the processor
32       */
33      public String getName();
34      
35      /**
36       * The file extension that the processor is associated with, null if none.
37       * 
38       * @return  the extension
39       */
40      public String getExtension();
41      
42      /**
43       * Registers a processor extension with the processor
44       * 
45       * @param processorExtension    the process extension
46       */
47      public void registerProcessorExtension(ProcessorExtension processorExtension);
48  }