001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020package org.apache.directory.api.ldap.codec.controls.search.entryChange; 021 022 023import org.apache.directory.api.asn1.ber.grammar.Grammar; 024import org.apache.directory.api.asn1.ber.grammar.States; 025 026 027/** 028 * This class store the EntryChangeControl's grammar constants. It is also used 029 * for debugging purposes. 030 * 031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 032 */ 033public enum EntryChangeStates implements States 034{ 035 // ~ Static fields/initializers 036 // ----------------------------------------------------------------- 037 038 /** The END_STATE */ 039 END_STATE, 040 041 // ========================================================================= 042 // Entry change control grammar states 043 // ========================================================================= 044 045 /** Sequence Tag */ 046 START_STATE, 047 048 /** Sequence */ 049 EC_SEQUENCE_STATE, 050 051 /** changeType */ 052 CHANGE_TYPE_STATE, 053 054 /** previousDN */ 055 PREVIOUS_DN_STATE, 056 057 /** changeNumber */ 058 CHANGE_NUMBER_STATE, 059 060 /** terminal state */ 061 LAST_EC_STATE; 062 063 /** 064 * Get the grammar name 065 * 066 * @return The grammar name 067 */ 068 public String getGrammarName() 069 { 070 return "EC_GRAMMAR"; 071 } 072 073 074 /** 075 * Get the grammar name 076 * 077 * @param grammar The grammar class 078 * @return The grammar name 079 */ 080 public String getGrammarName( Grammar<?> grammar ) 081 { 082 if ( grammar instanceof EntryChangeGrammar ) 083 { 084 return "EC_GRAMMAR"; 085 } 086 087 return "UNKNOWN GRAMMAR"; 088 } 089 090 091 /** 092 * Get the string representing the state 093 * 094 * @param state The state number 095 * @return The String representing the state 096 */ 097 public String getState( int state ) 098 { 099 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}