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.search.persistentSearch;
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 PSearchControl's grammar constants. It is also used for
29 * debugging purposes.
30 *
31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32 */
33 public enum PersistentSearchStates implements States
34 {
35 // ~ Static fields/initializers
36 // -----------------------------------------------------------------
37
38 /** The END_STATE */
39 END_STATE,
40
41 // =========================================================================
42 // Persistent search control grammar states
43 // =========================================================================
44 /** Initial state */
45 START_STATE,
46
47 /** Sequence Value */
48 PSEARCH_SEQUENCE_STATE,
49
50 /** changeTypes Value */
51 CHANGE_TYPES_STATE,
52
53 /** changesOnly Value */
54 CHANGES_ONLY_STATE,
55
56 /** returnECs Value */
57 RETURN_ECS_STATE,
58
59 /** terminal state */
60 LAST_PSEARCH_STATE;
61
62 /**
63 * Get the grammar name
64 *
65 * @return The grammar name
66 */
67 public String getGrammarName()
68 {
69 return "PSEARCH_GRAMMAR";
70 }
71
72
73 /**
74 * Get the grammar name
75 *
76 * @param grammar The grammar class
77 * @return The grammar name
78 */
79 public String getGrammarName( Grammar<?> grammar )
80 {
81 if ( grammar instanceof PersistentSearchGrammar )
82 {
83 return "PSEARCH_GRAMMAR";
84 }
85
86 return "UNKNOWN GRAMMAR";
87 }
88
89
90 /**
91 * Get the string representing the state
92 *
93 * @param state The state number
94 * @return The String representing the state
95 */
96 public String getState( int state )
97 {
98 return ( ( state == END_STATE.ordinal() ) ? "PSEARCH_END_STATE" : name() );
99 }
100
101
102 /**
103 * {@inheritDoc}
104 */
105 public boolean isEndState()
106 {
107 return this == END_STATE;
108 }
109
110
111 /**
112 * {@inheritDoc}
113 */
114 public PersistentSearchStates getStartState()
115 {
116 return START_STATE;
117 }
118 }