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.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 * 
031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032 */
033public interface Grammar
034{
035    /**
036     * This method, when called, executes an action on the current data stored in
037     * the container.
038     * 
039     * @param container the DSML container
040     * @throws XmlPullParserException when an unrecoverable error occurs
041     * @throws IOException when an IO error occurs
042     */
043    void executeAction( Dsmlv2Container container ) throws XmlPullParserException, IOException;
044
045
046    /**
047     * Get the grammar name
048     * 
049     * @return Return the grammar's name
050     */
051    String getName();
052
053
054    /**
055     * Get the statesEnum for the current grammar
056     * 
057     * @return The specific States Enum for the current grammar
058     */
059    Enum<Dsmlv2StatesEnum>[] getStatesEnum();
060
061
062    /**
063     * Set the grammar's name
064     * 
065     * @param name The grammar name
066     */
067    void setName( String name );
068}