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.entryChange; 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 EntryChangeControl's grammar constants. It is also used 29 * for debugging purposes. 30 * 31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 32 */ 33 public enum EntryChangeStates implements States 34 { 35 // ~ Static fields/initializers 36 // ----------------------------------------------------------------- 37 38 /** The END_STATE */ 39 END_STATE, 40 41 // ========================================================================= 42 // Entry change control grammar states 43 // ========================================================================= 44 45 /** Sequence Tag */ 46 START_STATE, 47 48 /** Sequence */ 49 EC_SEQUENCE_STATE, 50 51 /** changeType */ 52 CHANGE_TYPE_STATE, 53 54 /** previousDN */ 55 PREVIOUS_DN_STATE, 56 57 /** changeNumber */ 58 CHANGE_NUMBER_STATE, 59 60 /** terminal state */ 61 LAST_EC_STATE; 62 63 /** 64 * Get the grammar name 65 * 66 * @return The grammar name 67 */ 68 public String getGrammarName() 69 { 70 return "EC_GRAMMAR"; 71 } 72 73 74 /** 75 * Get the grammar name 76 * 77 * @param grammar The grammar class 78 * @return The grammar name 79 */ 80 public String getGrammarName( Grammar<?> grammar ) 81 { 82 if ( grammar instanceof EntryChangeGrammar ) 83 { 84 return "EC_GRAMMAR"; 85 } 86 87 return "UNKNOWN GRAMMAR"; 88 } 89 90 91 /** 92 * Get the string representing the state 93 * 94 * @param state The state number 95 * @return The String representing the state 96 */ 97 public String getState( int state ) 98 { 99 return ( ( state == END_STATE.ordinal() ) ? "EC_END_STATE" : name() ); 100 } 101 102 103 /** 104 * {@inheritDoc} 105 */ 106 public boolean isEndState() 107 { 108 return this == END_STATE; 109 } 110 111 112 /** 113 * {@inheritDoc} 114 */ 115 public EntryChangeStates getStartState() 116 { 117 return START_STATE; 118 } 119 }