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.directory.api.asn1.ber.grammar;
21  
22  
23  import org.apache.directory.api.asn1.DecoderException;
24  import org.apache.directory.api.asn1.ber.Asn1Container;
25  
26  
27  /**
28   * The interface which expose common behavior of a Grammar implementer.
29   *
30   * @param C The container type
31   * 
32   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33   */
34  public interface Grammar<C extends Asn1Container>
35  {
36      /**
37       * This method, when called, execute an action on the current data stored in
38       * the container.
39       *
40       * @param asn1Container Store the data being processed.
41       * @throws DecoderException Thrown when an unrecoverable error occurs.
42       */
43      void executeAction( C asn1Container ) throws DecoderException;
44  
45  
46      /**
47       * Get the grammar name
48       *
49       * @return Return the grammar's name
50       */
51      String getName();
52  
53  
54      /**
55       * Set the grammar's name
56       *
57       * @param name The grammar name
58       */
59      void setName( String name );
60  }