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.entryChange;
21
22
23 import org.apache.directory.api.asn1.ber.grammar.States;
24
25
26 /**
27 * This class store the EntryChangeControl'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 EntryChangeStates implements States
33 {
34 // ~ Static fields/initializers
35 // -----------------------------------------------------------------
36
37 /** The END_STATE */
38 END_STATE,
39
40 // =========================================================================
41 // Entry change control grammar states
42 // =========================================================================
43
44 /** Sequence Tag */
45 START_STATE,
46
47 /** Sequence */
48 EC_SEQUENCE_STATE,
49
50 /** changeType */
51 CHANGE_TYPE_STATE,
52
53 /** previousDN */
54 PREVIOUS_DN_STATE,
55
56 /** changeNumber */
57 CHANGE_NUMBER_STATE,
58
59 /** terminal state */
60 LAST_EC_STATE;
61
62 /**
63 * Get the grammar name
64 *
65 * @return The grammar name
66 */
67 public String getGrammarName()
68 {
69 return "EC_GRAMMAR";
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() ) ? "EC_END_STATE" : 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 EntryChangeStates getStartState()
100 {
101 return START_STATE;
102 }
103 }