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.shared.ldap.codec.controls.search.subentries; 021 022 023import org.apache.directory.shared.asn1.ber.grammar.Grammar; 024import org.apache.directory.shared.asn1.ber.grammar.States; 025 026 027/** 028 * This class store the SubEntryControl's grammar constants. It is also used for 029 * debugging purposes. 030 * 031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 032 */ 033public enum SubentriesStates implements States 034{ 035 // ~ Static fields/initializers 036 // ----------------------------------------------------------------- 037 038 /** The END_STATE */ 039 END_STATE, 040 041 // ========================================================================= 042 // Sub entry control grammar states 043 // ========================================================================= 044 045 /** Starting state */ 046 START_STATE, 047 048 /** Visibility Value */ 049 SUB_ENTRY_VISIBILITY_STATE, 050 051 /** terminal state */ 052 LAST_SUB_ENTRY_STATE; 053 054 055 /** 056 * Get the grammar name 057 * 058 * @param grammar The grammar code 059 * @return The grammar name 060 */ 061 public String getGrammarName( int grammar ) 062 { 063 return "SUB_ENTRY_GRAMMAR"; 064 } 065 066 067 /** 068 * Get the grammar name 069 * 070 * @param grammar The grammar class 071 * @return The grammar name 072 */ 073 public String getGrammarName( Grammar<SubentriesContainer> grammar ) 074 { 075 if ( grammar instanceof SubentriesGrammar ) 076 { 077 return "SUB_ENTRY_GRAMMAR"; 078 } 079 080 return "UNKNOWN GRAMMAR"; 081 } 082 083 084 /** 085 * Get the string representing the state 086 * 087 * @param state The state number 088 * @return The String representing the state 089 */ 090 public String getState( int state ) 091 { 092 return ( ( state == END_STATE.ordinal() ) ? "SUB_ENTRY_END_STATE" : name() ); 093 } 094 095 096 /** 097 * {@inheritDoc} 098 */ 099 public boolean isEndState() 100 { 101 return this == END_STATE; 102 } 103 104 105 /** 106 * {@inheritDoc} 107 */ 108 public SubentriesStates getStartState() 109 { 110 return START_STATE; 111 } 112}