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 SyncStateValueControl'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 SyncStateValueStatesEnum implements States
34 {
35 /** The END_STATE */
36 END_STATE,
37
38 // =========================================================================
39 // SyncStateValue control grammar states
40 // =========================================================================
41 /** Initial state */
42 START_STATE,
43
44 /** Sequence Value */
45 SYNC_STATE_VALUE_SEQUENCE_STATE,
46
47 /** sync state type Value */
48 SYNC_TYPE_STATE,
49
50 /** syncUUID Value */
51 SYNC_UUID_STATE,
52
53 /** cookie Value */
54 COOKIE_STATE,
55
56 /** terminal state */
57 LAST_SYNC_STATE_VALUE_STATE;
58
59 /**
60 * Get the grammar name
61 *
62 * @param grammar The grammar code
63 * @return The grammar name
64 */
65 public String getGrammarName( int grammar )
66 {
67 return "SYNC_REQUEST_VALUE_GRAMMAR";
68 }
69
70
71 /**
72 * Get the grammar name
73 *
74 * @param grammar The grammar class
75 * @return The grammar name
76 */
77 public String getGrammarName( Grammar<SyncStateValueContainer> grammar )
78 {
79 if ( grammar instanceof SyncStateValueGrammar )
80 {
81 return "SYNC_STATE_VALUE_GRAMMAR";
82 }
83
84 return "UNKNOWN GRAMMAR";
85 }
86
87
88 /**
89 * Get the string representing the state
90 *
91 * @param state The state number
92 * @return The String representing the state
93 */
94 public String getState( int state )
95 {
96 return ( ( state == END_STATE.ordinal() ) ? "SYNC_STATE_VALUE_END_STATE" : this.name() );
97 }
98
99
100 /**
101 * {@inheritDoc}
102 */
103 public boolean isEndState()
104 {
105 return this == END_STATE;
106 }
107
108
109 /**
110 * {@inheritDoc}
111 */
112 public SyncStateValueStatesEnum getStartState()
113 {
114 return START_STATE;
115 }
116 }