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 */
020 package org.apache.directory.shared.asn1.ber.grammar;
021
022
023 import org.apache.directory.shared.asn1.ber.IAsn1Container;
024 import org.apache.directory.shared.asn1.codec.DecoderException;
025
026
027 /**
028 * The interface which expose common behavior of a Gramar implementer.
029 *
030 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
031 * @version $Rev: 664290 $, $Date: 2008-06-07 08:28:06 +0200 (Sam, 07 jui 2008) $
032 */
033 public interface IGrammar
034 {
035 // ~ Methods
036 // ------------------------------------------------------------------------------------
037
038 /**
039 * This method, when called, execute an action on the current data stored in
040 * the container.
041 *
042 * @param asn1Container
043 * Store the data being processed.
044 * @throws DecoderException
045 * Thrown when an unrecoverable error occurs.
046 */
047 void executeAction( IAsn1Container asn1Container ) throws DecoderException;
048
049
050 /**
051 * Get the grammar name
052 *
053 * @return Return the grammar's name
054 */
055 String getName();
056
057
058 /**
059 * Get the statesEnum for the current grammar
060 *
061 * @return The specific States Enum for the current grammar
062 */
063 IStates getStatesEnum();
064
065
066 /**
067 * Set the grammar's name
068 *
069 * @param name
070 * The grammar name
071 */
072 void setName( String name );
073 }