View Javadoc

1   /****************************************************************
2    * Licensed to the Apache Software Foundation (ASF) under one   *
3    * or more contributor license agreements.  See the NOTICE file *
4    * distributed with this work for additional information        *
5    * regarding copyright ownership.  The ASF licenses this file   *
6    * to you under the Apache License, Version 2.0 (the            *
7    * "License"); you may not use this file except in compliance   *
8    * with the License.  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,   *
13   * software distributed under the License is distributed on an  *
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
15   * KIND, either express or implied.  See the License for the    *
16   * specific language governing permissions and limitations      *
17   * under the License.                                           *
18   ****************************************************************/
19  
20  package org.apache.jsieve;
21  
22  import org.apache.jsieve.exception.LookupException;
23  
24  /**
25   * Maps Command names to configured Command implementation classes.
26   */
27  public interface CommandManager {
28  
29      /**
30       * <p>
31       * Method newInstance answers an instance of the class to which a Command
32       * name is mapped.
33       * </p>
34       * 
35       * @param name -
36       *            The name of the Command
37       * @return Class - The class of the Command
38       * @throws LookupException
39       */
40      public ExecutableCommand getCommand(String name) throws LookupException;
41  
42      /**
43       * Method isSupported answers a boolean indicating if a Command name is
44       * configured.
45       * 
46       * @param name -
47       *            The Command name
48       * @return boolean - True if the Command name is configured.
49       */
50      public boolean isCommandSupported(String name);
51  }