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