View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *  
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *  
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License. 
18   *  
19   */
20  package org.apache.directory.api.ldap.extras.extended.ads_impl.whoAmI;
21  
22  
23  import org.apache.directory.api.asn1.ber.grammar.States;
24  
25  
26  /**
27   * This class store the WhoAmIResponse's grammar constants. It is also used
28   * for debugging purposes.
29   * 
30   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
31   */
32  public enum WhoAmIResponseStatesEnum implements States
33  {
34  
35      /** The END_STATE */
36      END_STATE,
37  
38      /** start state*/
39      START_STATE,
40  
41      /** the authzid */
42      AUTHZ_ID_RESPONSE_STATE,
43  
44      /** Last state */
45      LAST_WHO_AM_I_RESPONSE_STATE;
46  
47  
48      /**
49       * Get the grammar name
50       * 
51       * @return The grammar name
52       */
53      public String getGrammarName()
54      {
55          return "WHO_AM_I_RESPONSE_GRAMMER";
56      }
57  
58  
59      /**
60       * Get the string representing the state
61       * 
62       * @param state The state number
63       * @return The String representing the state
64       */
65      public String getState( int state )
66      {
67          return ( state == END_STATE.ordinal() ) ? "WHO_AM_I_RESPONSE_GRAMMER" : name();
68      }
69  
70  
71      /**
72       * {@inheritDoc}
73       */
74      @Override
75      public boolean isEndState()
76      {
77          return this == END_STATE;
78      }
79  
80  
81      /**
82       * {@inheritDoc}
83       */
84      @Override
85      public WhoAmIResponseStatesEnum getStartState()
86      {
87          return START_STATE;
88      }
89  }