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.dsmlv2;
021
022
023import java.io.IOException;
024
025import org.xmlpull.v1.XmlPullParserException;
026
027
028/**
029 * The interface which expose common behavior of a Grammar implementer.
030 */
031public interface Grammar
032{
033    /**
034     * This method, when called, executes an action on the current data stored in
035     * the container.
036     * 
037     * @param container
038     *            the DSML container
039     * @throws XmlPullParserException when an unrecoverable error occurs
040     * @throws IOException when an IO error occurs
041     */
042    void executeAction( Dsmlv2Container container ) throws XmlPullParserException, IOException;
043
044
045    /**
046     * Get the grammar name
047     * 
048     * @return Return the grammar's name
049     */
050    String getName();
051
052
053    /**
054     * Get the statesEnum for the current grammar
055     * 
056     * @return The specific States Enum for the current grammar
057     */
058    Enum<Dsmlv2StatesEnum>[] getStatesEnum();
059
060
061    /**
062     * Set the grammar's name
063     * 
064     * @param name
065     *            The grammar name
066     */
067    void setName( String name );
068}