IGrammar


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  
21  package org.apache.directory.ldapstudio.dsmlv2;
22  
23  
24  import java.io.IOException  ;
25  
26  import org.xmlpull.v1.XmlPullParserException;
27  
28  
29  /**
30   * The interface which expose common behavior of a Gramar implementer.
31   */
32  public interface IGrammar
33  {
34      // ~ Methods
35      // ------------------------------------------------------------------------------------
36  
37      /**
38       * This method, when called, execute an action on the current data stored in
39       * the container.
40       * 
41       * @param container
42       *            the DSML container
43       * @throws XmlPullParserException
44       *      Thrown when an unrecoverable error occurs.
45       * @throws IOException
46       */
47      void executeAction( Dsmlv2Container container ) throws XmlPullParserException, IOException  ;
48  
49  
50      /**
51       * Get the grammar name
52       * 
53       * @return Return the grammar's name
54       */
55      String   getName();
56  
57  
58      /**
59       * Get the statesEnum for the current grammar
60       * 
61       * @return The specific States Enum for the current grammar
62       */
63      IStates getStatesEnum();
64  
65  
66      /**
67       * Set the grammar's name
68       * 
69       * @param name
70       *            The grammar name
71       */
72      void setName( String   name );
73  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags