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.extras.controls.syncrepl_impl;
21
22
23 import org.apache.directory.api.asn1.ber.grammar.States;
24
25
26 /**
27 * This class store the SyncRequestValueControl's grammar constants. It is also used for
28 * debugging purposes.
29 *
30 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
31 */
32 public enum SyncRequestValueStatesEnum implements States
33 {
34 // ~ Static fields/initializers
35 // -----------------------------------------------------------------
36
37 /** The END_STATE */
38 END_STATE,
39
40 // =========================================================================
41 // SyncRequestValue control grammar states
42 // =========================================================================
43 /** Initial state */
44 START_STATE,
45
46 /** Sequence Value */
47 SYNC_REQUEST_VALUE_SEQUENCE_STATE,
48
49 /** mode Value */
50 MODE_STATE,
51
52 /** cookie Value */
53 COOKIE_STATE,
54
55 /** reloadHint Value */
56 RELOAD_HINT_STATE,
57
58 /** terminal state */
59 LAST_SYNC_REQUEST_VALUE_STATE;
60
61 /**
62 * Get the grammar name
63 *
64 * @return The grammar name
65 */
66 public String getGrammarName()
67 {
68 return "SYNC_REQUEST_VALUE_GRAMMAR";
69 }
70
71
72 /**
73 * Get the string representing the state
74 *
75 * @param state The state number
76 * @return The String representing the state
77 */
78 public String getState( int state )
79 {
80 return ( state == END_STATE.ordinal() ) ? "SYNC_REQUEST_VALUE_END_STATE" : this.name();
81 }
82
83
84 /**
85 * {@inheritDoc}
86 */
87 @Override
88 public boolean isEndState()
89 {
90 return this == END_STATE;
91 }
92
93
94 /**
95 * {@inheritDoc}
96 */
97 @Override
98 public SyncRequestValueStatesEnum getStartState()
99 {
100 return START_STATE;
101 }
102 }