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.Grammar;
24 import org.apache.directory.api.asn1.ber.grammar.States;
25
26
27 /**
28 * This class store the SyncRequestValueControl'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 SyncRequestValueStatesEnum implements States
34 {
35 // ~ Static fields/initializers
36 // -----------------------------------------------------------------
37
38 /** The END_STATE */
39 END_STATE,
40
41 // =========================================================================
42 // SyncRequestValue control grammar states
43 // =========================================================================
44 /** Initial state */
45 START_STATE,
46
47 /** Sequence Value */
48 SYNC_REQUEST_VALUE_SEQUENCE_STATE,
49
50 /** mode Value */
51 MODE_STATE,
52
53 /** cookie Value */
54 COOKIE_STATE,
55
56 /** reloadHint Value */
57 RELOAD_HINT_STATE,
58
59 /** terminal state */
60 LAST_SYNC_REQUEST_VALUE_STATE;
61
62 /**
63 * Get the grammar name
64 *
65 * @param grammar The grammar code
66 * @return The grammar name
67 */
68 public String getGrammarName( int grammar )
69 {
70 return "SYNC_REQUEST_VALUE_GRAMMAR";
71 }
72
73
74 /**
75 * Get the grammar name
76 *
77 * @param grammar The grammar class
78 * @return The grammar name
79 */
80 public String getGrammarName( Grammar<SyncRequestValueContainer> grammar )
81 {
82 if ( grammar instanceof SyncRequestValueGrammar )
83 {
84 return "SYNC_REQUEST_VALUE_GRAMMAR";
85 }
86
87 return "UNKNOWN GRAMMAR";
88 }
89
90
91 /**
92 * Get the string representing the state
93 *
94 * @param state The state number
95 * @return The String representing the state
96 */
97 public String getState( int state )
98 {
99 return ( ( state == END_STATE.ordinal() ) ? "SYNC_REQUEST_VALUE_END_STATE" : this.name() );
100 }
101
102
103 /**
104 * {@inheritDoc}
105 */
106 public boolean isEndState()
107 {
108 return this == END_STATE;
109 }
110
111
112 /**
113 * {@inheritDoc}
114 */
115 public SyncRequestValueStatesEnum getStartState()
116 {
117 return START_STATE;
118 }
119 }