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.shared.ldap.extras.extended.ads_impl.cancel;
021
022
023import org.apache.directory.shared.asn1.ber.grammar.Grammar;
024import org.apache.directory.shared.asn1.ber.grammar.States;
025
026
027/**
028 * This class store the Cancel's grammar constants. It is also used
029 * for debugging purposes.
030 * 
031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032 */
033public enum CancelStatesEnum implements States
034{
035    // ~ Static fields/initializers
036    // -----------------------------------------------------------------
037
038    /** The END_STATE */
039    END_STATE,
040
041    // =========================================================================
042    // Cancel grammar states
043    // =========================================================================
044    /** Initial state */
045    START_STATE,
046
047    /** Sequence */
048    CANCEL_SEQUENCE_STATE,
049
050    /** cancelId */
051    CANCEL_ID_STATE,
052
053    /** terminal state */
054    LAST_CANCEL_STATE;
055
056    /**
057     * Get the grammar name
058     * 
059     * @param grammar The grammar code
060     * @return The grammar name
061     */
062    public String getGrammarName( int grammar )
063    {
064        return "CANCEL_GRAMMAR";
065    }
066
067
068    /**
069     * Get the grammar name
070     * 
071     * @param grammar The grammar class
072     * @return The grammar name
073     */
074    public String getGrammarName( Grammar<CancelContainer> grammar )
075    {
076        return "CANCEL_GRAMMAR";
077    }
078
079
080    /**
081     * Get the string representing the state
082     * 
083     * @param state The state number
084     * @return The String representing the state
085     */
086    public String getState( int state )
087    {
088        return ( ( state == END_STATE.ordinal() ) ? "CANCEL_END_STATE" : this.name() );
089    }
090
091    
092    /**
093     * {@inheritDoc}
094     */
095    public boolean isEndState()
096    {
097        return this == END_STATE;
098    }
099    
100    
101    /**
102     * {@inheritDoc}
103     */
104    public CancelStatesEnum getStartState()
105    {
106        return START_STATE;
107    }
108}