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.Grammar;
24  import org.apache.directory.api.asn1.ber.grammar.States;
25  
26  
27  /**
28   * Codec states for SortRequestControl.
29   *
30   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
31   */
32  public enum SortRequestStates implements States
33  {
34      START_STATE,
35  
36      SEQUENCE_OF_SEQUENCE_STATE,
37      
38      SORT_KEY_SEQUENCE_STATE,
39  
40      AT_DESC_STATE,
41  
42      ORDER_RULE_STATE,
43  
44      REVERSE_ORDER_STATE,
45  
46      END_STATE;
47  
48      /**
49       * Get the grammar name
50       * 
51       * @param grammar The grammar code
52       * @return The grammar name
53       */
54      public String getGrammarName( int grammar )
55      {
56          return "SORT_REQUEST_GRAMMAR";
57      }
58  
59  
60      /**
61       * Get the grammar name
62       * 
63       * @param grammar The grammar class
64       * @return The grammar name
65       */
66      public String getGrammarName( Grammar<?> grammar )
67      {
68          if ( grammar instanceof SortRequestGrammar )
69          {
70              return "SORT_REQUEST_GRAMMAR";
71          }
72  
73          return "UNKNOWN GRAMMAR";
74      }
75  
76  
77      /**
78       * Get the string representing the state
79       * 
80       * @param state The state number
81       * @return The String representing the state
82       */
83      public String getState( int state )
84      {
85          return ( ( state == END_STATE.ordinal() ) ? "SORT_REQUEST_END_STATE" : name() );
86      }
87  
88  
89      @Override
90      public boolean isEndState()
91      {
92          return ( this == END_STATE );
93      }
94  
95  
96      @Override
97      public Enum<?> getStartState()
98      {
99          return START_STATE;
100     }
101 
102 }