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
023/**
024 * This interface represents a container that can be used by the parser to store parsed information
025 *
026 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
027 */
028public interface Container
029{
030    /**
031     * Gets the current grammar state
032     * 
033     * @return Returns the current grammar state
034     */
035    Enum<Dsmlv2StatesEnum> getState();
036
037
038    /**
039     * Sets the new current state
040     * 
041     * @param state The new state
042     */
043    void setState( Enum<Dsmlv2StatesEnum> state );
044
045
046    /**
047     * Gets the transition
048     * 
049     * @return Returns the transition from the previous state to the new state
050     */
051    Enum<Dsmlv2StatesEnum> getTransition();
052
053
054    /**
055     * Updates the transition from a state to another
056     * 
057     * @param transition The transition to set
058     */
059    void setTransition( Enum<Dsmlv2StatesEnum> transition );
060
061
062    /**
063     * @return Returns the states.
064     */
065    Enum<Dsmlv2StatesEnum>[] getStates();
066}