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.extended.ads_impl.whoAmI;
021
022
023import org.apache.directory.api.asn1.ber.grammar.States;
024
025
026/**
027 * This class store the WhoAmIResponse's grammar constants. It is also used
028 * for debugging purposes.
029 * 
030 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
031 */
032public enum WhoAmIResponseStatesEnum implements States
033{
034
035    /** The END_STATE */
036    END_STATE,
037
038    /** start state*/
039    START_STATE,
040
041    /** the authzid */
042    AUTHZ_ID_RESPONSE_STATE,
043
044    /** Last state */
045    LAST_WHO_AM_I_RESPONSE_STATE;
046
047
048    /**
049     * Get the grammar name
050     * 
051     * @return The grammar name
052     */
053    public String getGrammarName()
054    {
055        return "WHO_AM_I_RESPONSE_GRAMMER";
056    }
057
058
059    /**
060     * Get the string representing the state
061     * 
062     * @param state The state number
063     * @return The String representing the state
064     */
065    public String getState( int state )
066    {
067        return ( state == END_STATE.ordinal() ) ? "WHO_AM_I_RESPONSE_GRAMMER" : name();
068    }
069
070
071    /**
072     * {@inheritDoc}
073     */
074    @Override
075    public boolean isEndState()
076    {
077        return this == END_STATE;
078    }
079
080
081    /**
082     * {@inheritDoc}
083     */
084    @Override
085    public WhoAmIResponseStatesEnum getStartState()
086    {
087        return START_STATE;
088    }
089}