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.ldap.extras.controls.syncrepl_impl;
021
022
023import org.apache.directory.api.asn1.ber.grammar.Grammar;
024import org.apache.directory.api.asn1.ber.grammar.States;
025
026
027/**
028 * This class store the SyncRequestValueControl's grammar constants. It is also used for
029 * debugging purposes.
030 * 
031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032 */
033public enum SyncRequestValueStatesEnum implements States
034{
035    // ~ Static fields/initializers
036    // -----------------------------------------------------------------
037
038    /** The END_STATE */
039    END_STATE,
040
041    // =========================================================================
042    // SyncRequestValue control grammar states
043    // =========================================================================
044    /** Initial state */
045    START_STATE,
046
047    /** Sequence Value */
048    SYNC_REQUEST_VALUE_SEQUENCE_STATE,
049
050    /** mode Value */
051    MODE_STATE,
052
053    /** cookie Value */
054    COOKIE_STATE,
055
056    /** reloadHint Value */
057    RELOAD_HINT_STATE,
058
059    /** terminal state */
060    LAST_SYNC_REQUEST_VALUE_STATE;
061
062    /**
063     * Get the grammar name
064     * 
065     * @param grammar The grammar code
066     * @return The grammar name
067     */
068    public String getGrammarName( int grammar )
069    {
070        return "SYNC_REQUEST_VALUE_GRAMMAR";
071    }
072
073
074    /**
075     * Get the grammar name
076     * 
077     * @param grammar The grammar class
078     * @return The grammar name
079     */
080    public String getGrammarName( Grammar<SyncRequestValueContainer> grammar )
081    {
082        if ( grammar instanceof SyncRequestValueGrammar )
083        {
084            return "SYNC_REQUEST_VALUE_GRAMMAR";
085        }
086
087        return "UNKNOWN GRAMMAR";
088    }
089
090
091    /**
092     * Get the string representing the state
093     * 
094     * @param state The state number
095     * @return The String representing the state
096     */
097    public String getState( int state )
098    {
099        return ( ( state == END_STATE.ordinal() ) ? "SYNC_REQUEST_VALUE_END_STATE" : this.name() );
100    }
101
102
103    /**
104     * {@inheritDoc}
105     */
106    public boolean isEndState()
107    {
108        return this == END_STATE;
109    }
110
111
112    /**
113     * {@inheritDoc}
114     */
115    public SyncRequestValueStatesEnum getStartState()
116    {
117        return START_STATE;
118    }
119}