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.asn1.ber.grammar; 021 022 023import org.apache.directory.api.asn1.DecoderException; 024import org.apache.directory.api.asn1.ber.Asn1Container; 025 026 027/** 028 * The interface which expose common behavior of a Grammar implementer. 029 * 030 * @param C The container type 031 * 032 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 033 */ 034public interface Grammar<C extends Asn1Container> 035{ 036 /** 037 * This method, when called, execute an action on the current data stored in 038 * the container. 039 * 040 * @param asn1Container Store the data being processed. 041 * @throws DecoderException Thrown when an unrecoverable error occurs. 042 */ 043 void executeAction( C asn1Container ) throws DecoderException; 044 045 046 /** 047 * Get the grammar name 048 * 049 * @return Return the grammar's name 050 */ 051 String getName(); 052 053 054 /** 055 * Set the grammar's name 056 * 057 * @param name The grammar name 058 */ 059 void setName( String name ); 060}