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.pwdModify;
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 PasswordModifyResponse'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 PasswordModifyResponseStatesEnum implements States
034{
035
036    /** The END_STATE */
037    END_STATE,
038
039    /** start state*/
040    START_STATE,
041
042    /** sequence*/
043    PASSWORD_MODIFY_RESPONSE_SEQUENCE_STATE,
044
045    /** the generated password */
046    GEN_PASSWORD_STATE,
047
048    /** Last state */
049    LAST_PASSWORD_MODIFY_RESPONSE_STATE;
050
051    /**
052     * Get the grammar name
053     * 
054     * @param grammar The grammar class
055     * @return The grammar name
056     */
057    public String getGrammarName( Grammar<PasswordModifyResponseContainer> grammar )
058    {
059        return "PASSWORD_MODIFY_RESPONSE_GRAMMER";
060    }
061
062
063    /**
064     * Get the grammar name
065     * 
066     * @param grammar The grammar code
067     * @return The grammar name
068     */
069    public String getGrammarName( int grammar )
070    {
071        return "PASSWORD_MODIFY_RESPONSE_GRAMMER";
072    }
073
074
075    /**
076     * Get the string representing the state
077     * 
078     * @param state The state number
079     * @return The String representing the state
080     */
081    public String getState( int state )
082    {
083        return ( ( state == END_STATE.ordinal() ) ? "PASSWORD_MODIFY_RESPONSE_GRAMMER" : this.name() );
084    }
085
086
087    /**
088     * {@inheritDoc}
089     */
090    public boolean isEndState()
091    {
092        return this == END_STATE;
093    }
094
095
096    /**
097     * {@inheritDoc}
098     */
099    public PasswordModifyResponseStatesEnum getStartState()
100    {
101        return START_STATE;
102    }
103}