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