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 * https://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
21 package org.apache.directory.api.ldap.extras.controls.vlv_impl;
22
23
24 import org.apache.directory.api.asn1.ber.grammar.States;
25
26
27 /**
28 * This class store the VirtualListViewResponse grammar constants. It is also used for
29 * debugging purposes.
30 *
31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32 */
33 public enum VirtualListViewResponseStates implements States
34 {
35 /** Initial state */
36 START_STATE,
37
38 /** VirtualListViewResponse ::= SEQUENCE transition */
39 VLV_SEQUENCE_STATE,
40
41 /** targetPosition INTEGER (0 .. maxInt) transition */
42 VLV_TARGET_POSITION_STATE,
43
44 /** contentCount INTEGER (0 .. maxInt) transition */
45 VLV_CONTENT_COUNT_STATE,
46
47 /** virtualListViewResult ENUMERATED transition */
48 VLV_VIRTUAL_LIST_VIEW_RESULT_STATE,
49
50 /** contextID OCTET STRING OPTIONAL transition */
51 VLV_CONTEXT_ID_STATE,
52
53 /** Final state */
54 END_STATE;
55
56 /**
57 * Get the grammar name
58 *
59 * @return The grammar name
60 */
61 public String getGrammarName()
62 {
63 return "VLV_RESPONSE_GRAMMAR";
64 }
65
66
67 /**
68 * Get the string representing the state
69 *
70 * @param state The state number
71 * @return The String representing the state
72 */
73 public String getState( int state )
74 {
75 return ( state == END_STATE.ordinal() ) ? "VLV_RESPONSE_END_STATE" : name();
76 }
77
78
79 /**
80 * {@inheritDoc}
81 */
82 @Override
83 public boolean isEndState()
84 {
85 return this == END_STATE;
86 }
87
88
89 /**
90 * {@inheritDoc}
91 */
92 @Override
93 public Enum<?> getStartState()
94 {
95 return START_STATE;
96 }
97 }