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.codec.controls.sort;
21  
22  
23  import org.apache.directory.api.asn1.ber.grammar.States;
24  
25  
26  /**
27   * Enumeration of states encountered while decoding a SortResponseControl.
28   *
29   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
30   */
31  public enum SortResponseStates implements States
32  {
33      /** Initialstate */ 
34      START_STATE,
35  
36      /** SortResult ::= SEQUENCE transition */
37      SEQUENCE_STATE,
38  
39      /** sortResult  ENUMERATED transition */
40      RESULT_CODE_STATE,
41      
42      /** attributeType [0] AttributeDescription OPTIONAL transition */
43      AT_DESC_STATE,
44  
45      /** Final state */
46      END_STATE;
47  
48      /**
49       * Get the grammar name
50       * 
51       * @return The grammar name
52       */
53      public String getGrammarName()
54      {
55          return "SORT_RESPONSE_GRAMMAR";
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() ) ? "SORT_REQUEST_END_STATE" : name();
68      }
69  
70  
71      @Override
72      public boolean isEndState()
73      {
74          return this == END_STATE;
75      }
76  
77  
78      @Override
79      public Enum<?> getStartState()
80      {
81          return START_STATE;
82      }
83  
84  }