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.gracefulShutdown;
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 GracefulShutdown'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 GracefulShutdownStatesEnum implements States
34 {
35 // ~ Static fields/initializers
36 // -----------------------------------------------------------------
37
38 /** The END_STATE */
39 END_STATE,
40
41 // =========================================================================
42 // GracefulShutdown grammar states
43 // =========================================================================
44
45 /** Initial state */
46 START_STATE,
47
48 /** Sequence */
49 GRACEFUL_SHUTDOWN_SEQUENCE_STATE,
50
51 /** Time offline */
52 TIME_OFFLINE_STATE,
53
54 /** Delay */
55 DELAY_STATE,
56
57 /** terminal state */
58 LAST_GRACEFUL_SHUTDOWN_STATE;
59
60 /**
61 * Get the grammar name
62 *
63 * @param grammar The grammar code
64 * @return The grammar name
65 */
66 public String getGrammarName( int grammar )
67 {
68 return "GRACEFUL_SHUTDOWN_GRAMMAR";
69 }
70
71
72 /**
73 * Get the grammar name
74 *
75 * @param grammar The grammar class
76 * @return The grammar name
77 */
78 public String getGrammarName( Grammar<GracefulShutdownContainer> grammar )
79 {
80 return "GRACEFUL_SHUTDOWN_GRAMMAR";
81 }
82
83
84 /**
85 * Get the string representing the state
86 *
87 * @param state The state number
88 * @return The String representing the state
89 */
90 public String getState( int state )
91 {
92 return ( ( state == END_STATE.ordinal() ) ? "GRACEFUL_SHUTDOWN_END_STATE" : name() );
93 }
94
95
96 /**
97 * {@inheritDoc}
98 */
99 public boolean isEndState()
100 {
101 return this == END_STATE;
102 }
103
104
105 /**
106 * {@inheritDoc}
107 */
108 public GracefulShutdownStatesEnum getStartState()
109 {
110 return START_STATE;
111 }
112 }