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