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   *    https://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.endTransaction;
21  
22  
23  import org.apache.directory.api.asn1.ber.grammar.States;
24  
25  
26  /**
27   * This class store the EndTransactionResponse'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 EndTransactionResponseStates implements States
33  {
34      /** The END_STATE */
35      END_STATE,
36      
37      /** start state*/
38      START_STATE,
39      
40      /** The initial SEQUENCE */
41      END_TRANSACTION_SEQUENCE_STATE,
42      
43      /** The failed message ID */
44      FAILED_MESSAGE_ID_STATE,
45      
46      /** The update controls SEQ */
47      UPDATE_CONTROLS_SEQ_STATE,
48      
49      /** The update control SEQ */
50      UPDATE_CONTROL_SEQ_STATE,
51      
52      /** THe control's message ID state */
53      CONTROL_MESSAGE_ID_STATE,
54      
55      /** The control's state */
56      CONTROLS_STATE,
57  
58      /** Last state */
59      LAST_STATE;
60  
61  
62      /**
63       * Get the grammar name
64       * 
65       * @return The grammar name
66       */
67      public String getGrammarName()
68      {
69          return "END_TRANSACTION_RESPONSE_GRAMMER";
70      }
71  
72  
73      /**
74       * Get the string representing the state
75       * 
76       * @param state The state number
77       * @return The String representing the state
78       */
79      public String getState( int state )
80      {
81          return ( state == END_STATE.ordinal() ) ? "END_TRANSACTION_RESPONSE_GRAMMER" : name();
82      }
83  
84  
85      /**
86       * {@inheritDoc}
87       */
88      @Override
89      public boolean isEndState()
90      {
91          return this == END_STATE;
92      }
93  
94  
95      /**
96       * {@inheritDoc}
97       */
98      @Override
99      public EndTransactionResponseStates getStartState()
100     {
101         return START_STATE;
102     }
103 }