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