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.States; 024 025 026/** 027 * This class store the EntryChangeControl's grammar constants. It is also used 028 * for debugging purposes. 029 * 030 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 031 */ 032public enum EntryChangeStates implements States 033{ 034 // ~ Static fields/initializers 035 // ----------------------------------------------------------------- 036 037 /** The END_STATE */ 038 END_STATE, 039 040 // ========================================================================= 041 // Entry change control grammar states 042 // ========================================================================= 043 044 /** Sequence Tag */ 045 START_STATE, 046 047 /** Sequence */ 048 EC_SEQUENCE_STATE, 049 050 /** changeType */ 051 CHANGE_TYPE_STATE, 052 053 /** previousDN */ 054 PREVIOUS_DN_STATE, 055 056 /** changeNumber */ 057 CHANGE_NUMBER_STATE, 058 059 /** terminal state */ 060 LAST_EC_STATE; 061 062 /** 063 * Get the grammar name 064 * 065 * @return The grammar name 066 */ 067 public String getGrammarName() 068 { 069 return "EC_GRAMMAR"; 070 } 071 072 073 /** 074 * Get the string representing the state 075 * 076 * @param state The state number 077 * @return The String representing the state 078 */ 079 public String getState( int state ) 080 { 081 return ( state == END_STATE.ordinal() ) ? "EC_END_STATE" : name(); 082 } 083 084 085 /** 086 * {@inheritDoc} 087 */ 088 @Override 089 public boolean isEndState() 090 { 091 return this == END_STATE; 092 } 093 094 095 /** 096 * {@inheritDoc} 097 */ 098 @Override 099 public EntryChangeStates getStartState() 100 { 101 return START_STATE; 102 } 103}