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.ber.Asn1Container;
24  
25  
26  /**
27   * A top level grammar class that store meta informations about the actions.
28   * Those informations are not mandatory, but they can be useful for debugging.
29   * 
30   * @param <C> The container type
31   * 
32   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33   */
34  public abstract class GrammarAction<C extends Asn1Container> implements Action<C>
35  {
36      /** The action's name */
37      protected String name;
38  
39  
40      /** A default constructor */
41      public GrammarAction()
42      {
43      }
44  
45  
46      /**
47       * Creates a new GrammarAction object.
48       * 
49       * @param name The name of the grammar action
50       */
51      public GrammarAction( String name )
52      {
53          this.name = name;
54      }
55  
56  
57      /**
58       * Prints the action's name
59       * 
60       * @return The action's name
61       */
62      @Override
63      public String toString()
64      {
65          return name;
66      }
67  }