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 is used to store the different states of a grammar.
026     *
027     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
028     * @version $Rev$, $Date$
029     */
030    public interface IStates
031    {
032        /** The initial state of every grammar */
033        static int INIT_GRAMMAR_STATE = 0;
034    
035        /** The ending state for every grammars */
036        static int GRAMMAR_END = -1;
037    
038        /** The END_STATE */
039        static int END_STATE = -1;
040    
041    
042        /** 
043         * Gets the specified state
044         * 
045         * @param state
046         *      the identifier of the state
047         * @return
048         *      the specified state
049         */
050        String getState( int state );
051    }