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.cancel;
21
22
23 import org.apache.directory.api.asn1.ber.grammar.States;
24
25
26 /**
27 * This class store the Cancel'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 CancelStatesEnum implements States
33 {
34 // ~ Static fields/initializers
35 // -----------------------------------------------------------------
36
37 /** The END_STATE */
38 END_STATE,
39
40 // =========================================================================
41 // Cancel grammar states
42 // =========================================================================
43 /** Initial state */
44 START_STATE,
45
46 /** Sequence */
47 CANCEL_SEQUENCE_STATE,
48
49 /** cancelId */
50 CANCEL_ID_STATE,
51
52 /** terminal state */
53 LAST_CANCEL_STATE;
54
55 /**
56 * Get the grammar name
57 *
58 * @return The grammar name
59 */
60 public String getGrammarName()
61 {
62 return "CANCEL_GRAMMAR";
63 }
64
65
66 /**
67 * Get the string representing the state
68 *
69 * @param state The state number
70 * @return The String representing the state
71 */
72 public String getState( int state )
73 {
74 return ( state == END_STATE.ordinal() ) ? "CANCEL_END_STATE" : this.name();
75 }
76
77
78 /**
79 * {@inheritDoc}
80 */
81 @Override
82 public boolean isEndState()
83 {
84 return this == END_STATE;
85 }
86
87
88 /**
89 * {@inheritDoc}
90 */
91 @Override
92 public CancelStatesEnum getStartState()
93 {
94 return START_STATE;
95 }
96 }