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.Grammar;
24 import org.apache.directory.api.asn1.ber.grammar.States;
25
26
27 /**
28 * This class store the GracefulDisconnect's grammar constants. It is also used
29 * for debugging purposes.
30 *
31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32 */
33 public enum GracefulDisconnectStatesEnum implements States
34 {
35 // ~ Static fields/initializers
36 // -----------------------------------------------------------------
37
38 /** The END_STATE */
39 END_STATE,
40
41 // =========================================================================
42 // GracefulDisconnect grammar states
43 // =========================================================================
44 /** Initial state */
45 START_STATE,
46
47 /** Sequence */
48 GRACEFUL_DISCONNECT_SEQUENCE_STATE,
49
50 /** Time offline */
51 TIME_OFFLINE_STATE,
52
53 /** Delay */
54 DELAY_STATE,
55
56 /** Replicated contexts */
57 REPLICATED_CONTEXTS_STATE,
58
59 /** Referral */
60 REFERRAL_STATE,
61
62 /** terminal state */
63 LAST_GRACEFUL_DISCONNECT_STATE;
64
65 /**
66 * Get the grammar name
67 *
68 * @param grammar The grammar code
69 * @return The grammar name
70 */
71 public String getGrammarName( int grammar )
72 {
73 return "GRACEFUL_DISCONNECT_GRAMMAR";
74 }
75
76
77 /**
78 * Get the grammar name
79 *
80 * @param grammar The grammar class
81 * @return The grammar name
82 */
83 public String getGrammarName( Grammar<GracefulDisconnectContainer> grammar )
84 {
85 return "GRACEFUL_DISCONNECT_GRAMMAR";
86 }
87
88
89 /**
90 * Get the string representing the state
91 *
92 * @param state The state number
93 * @return The String representing the state
94 */
95 public String getState( int state )
96 {
97 return ( ( state == END_STATE.ordinal() ) ? "GRACEFUL_DISCONNECT_END_STATE" : name() );
98 }
99
100
101 /**
102 * {@inheritDoc}
103 */
104 public boolean isEndState()
105 {
106 return this == END_STATE;
107 }
108
109
110 /**
111 * {@inheritDoc}
112 */
113 public GracefulDisconnectStatesEnum getStartState()
114 {
115 return START_STATE;
116 }
117 }