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 * Codec states for SortRequestControl.
28 *
29 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
30 */
31 public enum SortRequestStates implements States
32 {
33 /** Initial state */
34 START_STATE,
35
36 /** SortKeyList ::= SEQUENCE OF transition */
37 SEQUENCE_OF_SEQUENCE_STATE,
38
39 /** SortKeyList ::= SEQUENCE OF SEQUENCE transition */
40 SORT_KEY_SEQUENCE_STATE,
41
42 /** attributeType AttributeDescription transition */
43 AT_DESC_STATE,
44
45 /** orderingRule [0] MatchingRuleId OPTIONAL transition */
46 ORDER_RULE_STATE,
47
48 /** reverseOrder [1] BOOLEAN DEFAULT FALSE transition */
49 REVERSE_ORDER_STATE,
50
51 /** Final state */
52 END_STATE;
53
54 /**
55 * Get the grammar name
56 *
57 * @return The grammar name
58 */
59 public String getGrammarName()
60 {
61 return "SORT_REQUEST_GRAMMAR";
62 }
63
64
65 /**
66 * Get the string representing the state
67 *
68 * @param state The state number
69 * @return The String representing the state
70 */
71 public String getState( int state )
72 {
73 return ( state == END_STATE.ordinal() ) ? "SORT_REQUEST_END_STATE" : name();
74 }
75
76
77 /**
78 * {@inheritDoc}
79 */
80 @Override
81 public boolean isEndState()
82 {
83 return this == END_STATE;
84 }
85
86
87 /**
88 * {@inheritDoc}
89 */
90 @Override
91 public Enum<?> getStartState()
92 {
93 return START_STATE;
94 }
95 }