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.Grammar;
24  import org.apache.directory.api.asn1.ber.grammar.States;
25  
26  
27  /**
28   * This class store the WhoAmIResponse's grammar constants. It is also used
29   * for debugging purposes.
30   * 
31   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32   */
33  public enum WhoAmIResponseStatesEnum implements States
34  {
35  
36      /** The END_STATE */
37      END_STATE,
38  
39      /** start state*/
40      START_STATE,
41  
42      /** the authzid */
43      AUTHZ_ID_RESPONSE_STATE,
44  
45      /** Last state */
46      LAST_WHO_AM_I_RESPONSE_STATE;
47  
48      /**
49       * Get the grammar name
50       * 
51       * @param grammar The grammar class
52       * @return The grammar name
53       */
54      public String getGrammarName( Grammar<WhoAmIResponseContainer> grammar )
55      {
56          return "WHO_AM_I_RESPONSE_GRAMMER";
57      }
58  
59  
60      /**
61       * Get the grammar name
62       * 
63       * @param grammar The grammar code
64       * @return The grammar name
65       */
66      public String getGrammarName( int grammar )
67      {
68          return "WHO_AM_I_RESPONSE_GRAMMER";
69      }
70  
71  
72      /**
73       * Get the string representing the state
74       * 
75       * @param state The state number
76       * @return The String representing the state
77       */
78      public String getState( int state )
79      {
80          return ( ( state == END_STATE.ordinal() ) ? "WHO_AM_I_RESPONSE_GRAMMER" : this.name() );
81      }
82  
83  
84      /**
85       * {@inheritDoc}
86       */
87      public boolean isEndState()
88      {
89          return this == END_STATE;
90      }
91  
92  
93      /**
94       * {@inheritDoc}
95       */
96      public WhoAmIResponseStatesEnum getStartState()
97      {
98          return START_STATE;
99      }
100 }