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.extras.extended.ads_impl.cancel; 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 Cancel'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 CancelStatesEnum implements States 34 { 35 // ~ Static fields/initializers 36 // ----------------------------------------------------------------- 37 38 /** The END_STATE */ 39 END_STATE, 40 41 // ========================================================================= 42 // Cancel grammar states 43 // ========================================================================= 44 /** Initial state */ 45 START_STATE, 46 47 /** Sequence */ 48 CANCEL_SEQUENCE_STATE, 49 50 /** cancelId */ 51 CANCEL_ID_STATE, 52 53 /** terminal state */ 54 LAST_CANCEL_STATE; 55 56 /** 57 * Get the grammar name 58 * 59 * @param grammar The grammar code 60 * @return The grammar name 61 */ 62 public String getGrammarName( int grammar ) 63 { 64 return "CANCEL_GRAMMAR"; 65 } 66 67 68 /** 69 * Get the grammar name 70 * 71 * @param grammar The grammar class 72 * @return The grammar name 73 */ 74 public String getGrammarName( Grammar<CancelContainer> grammar ) 75 { 76 return "CANCEL_GRAMMAR"; 77 } 78 79 80 /** 81 * Get the string representing the state 82 * 83 * @param state The state number 84 * @return The String representing the state 85 */ 86 public String getState( int state ) 87 { 88 return ( ( state == END_STATE.ordinal() ) ? "CANCEL_END_STATE" : this.name() ); 89 } 90 91 92 /** 93 * {@inheritDoc} 94 */ 95 public boolean isEndState() 96 { 97 return this == END_STATE; 98 } 99 100 101 /** 102 * {@inheritDoc} 103 */ 104 public CancelStatesEnum getStartState() 105 { 106 return START_STATE; 107 } 108 }