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.codec.controls.search.subentries;
21
22
23 import org.apache.directory.api.asn1.ber.grammar.States;
24
25
26 /**
27 * This class store the SubEntryControl's grammar constants. It is also used for
28 * debugging purposes.
29 *
30 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
31 */
32 public enum SubentriesStates implements States
33 {
34 // ~ Static fields/initializers
35 // -----------------------------------------------------------------
36
37 /** The END_STATE */
38 END_STATE,
39
40 // =========================================================================
41 // Sub entry control grammar states
42 // =========================================================================
43
44 /** Starting state */
45 START_STATE,
46
47 /** Visibility Value */
48 SUB_ENTRY_VISIBILITY_STATE,
49
50 /** terminal state */
51 LAST_SUB_ENTRY_STATE;
52
53 /**
54 * Get the grammar name
55 *
56 * @return The grammar name
57 */
58 public String getGrammarName()
59 {
60 return "SUB_ENTRY_GRAMMAR";
61 }
62
63
64 /**
65 * Get the string representing the state
66 *
67 * @param state The state number
68 * @return The String representing the state
69 */
70 public String getState( int state )
71 {
72 return ( state == END_STATE.ordinal() ) ? "SUB_ENTRY_END_STATE" : name();
73 }
74
75
76 /**
77 * {@inheritDoc}
78 */
79 @Override
80 public boolean isEndState()
81 {
82 return this == END_STATE;
83 }
84
85
86 /**
87 * {@inheritDoc}
88 */
89 @Override
90 public SubentriesStates getStartState()
91 {
92 return START_STATE;
93 }
94 }