001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 * 
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 * 
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 * 
019 */
020package org.apache.directory.api.asn1.ber.grammar;
021
022
023import org.apache.directory.api.asn1.ber.Asn1Container;
024
025
026/**
027 * A top level grammar class that store meta informations about the actions.
028 * Those informations are not mandatory, but they can be useful for debugging.
029 * 
030 * @param <C> The container type
031 * 
032 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
033 */
034public abstract class GrammarAction<C extends Asn1Container> implements Action<C>
035{
036    /** The action's name */
037    protected String name;
038
039
040    /** A default constructor */
041    public GrammarAction()
042    {
043    }
044
045
046    /**
047     * Creates a new GrammarAction object.
048     * 
049     * @param name The name of the grammar action
050     */
051    public GrammarAction( String name )
052    {
053        this.name = name;
054    }
055
056
057    /**
058     * Prints the action's name
059     * 
060     * @return The action's name
061     */
062    @Override
063    public String toString()
064    {
065        return name;
066    }
067}