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.extended.ads_impl.gracefulDisconnect;
21
22
23 import org.apache.directory.api.asn1.ber.grammar.States;
24
25
26 /**
27 * This class store the GracefulDisconnect'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 GracefulDisconnectStatesEnum implements States
33 {
34 // ~ Static fields/initializers
35 // -----------------------------------------------------------------
36
37 /** The END_STATE */
38 END_STATE,
39
40 // =========================================================================
41 // GracefulDisconnect grammar states
42 // =========================================================================
43 /** Initial state */
44 START_STATE,
45
46 /** Sequence */
47 GRACEFUL_DISCONNECT_SEQUENCE_STATE,
48
49 /** Time offline */
50 TIME_OFFLINE_STATE,
51
52 /** Delay */
53 DELAY_STATE,
54
55 /** Replicated contexts */
56 REPLICATED_CONTEXTS_STATE,
57
58 /** Referral */
59 REFERRAL_STATE,
60
61 /** terminal state */
62 LAST_GRACEFUL_DISCONNECT_STATE;
63
64 /**
65 * Get the grammar name
66 *
67 * @return The grammar name
68 */
69 public String getGrammarName()
70 {
71 return "GRACEFUL_DISCONNECT_GRAMMAR";
72 }
73
74
75 /**
76 * Get the string representing the state
77 *
78 * @param state The state number
79 * @return The String representing the state
80 */
81 public String getState( int state )
82 {
83 return ( state == END_STATE.ordinal() ) ? "GRACEFUL_DISCONNECT_END_STATE" : name();
84 }
85
86
87 /**
88 * {@inheritDoc}
89 */
90 @Override
91 public boolean isEndState()
92 {
93 return this == END_STATE;
94 }
95
96
97 /**
98 * {@inheritDoc}
99 */
100 @Override
101 public GracefulDisconnectStatesEnum getStartState()
102 {
103 return START_STATE;
104 }
105 }