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.ldap.codec.controls.search.pagedSearch;
021
022
023import org.apache.directory.shared.asn1.ber.grammar.Grammar;
024import org.apache.directory.shared.asn1.ber.grammar.States;
025
026
027/**
028 * This class store the PagedSearchControl's grammar constants. It is also used for
029 * debugging purposes.
030 * 
031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032 */
033public enum PagedResultsStates implements States
034{
035    // ~ Static fields/initializers
036    // -----------------------------------------------------------------
037
038    /** The END_STATE */
039    END_STATE,
040
041    // =========================================================================
042    // Paged search control grammar states
043    // =========================================================================
044    /** Initial state */
045    START_STATE,
046
047    /** Sequence Value */
048    PAGED_SEARCH_SEQUENCE_STATE,
049
050    /** Size Value */
051    SIZE_STATE,
052    
053    /** Cookie Value */
054    COOKIE_STATE,
055
056    /** terminal state */
057    LAST_PAGED_SEARCH_STATE;
058
059
060    /**
061     * Get the grammar name
062     * 
063     * @param grammar The grammar code
064     * @return The grammar name
065     */
066    public String getGrammarName( int grammar )
067    {
068        return "PAGED_SEARCH_GRAMMAR";
069    }
070
071
072    /**
073     * Get the grammar name
074     * 
075     * @param grammar The grammar class
076     * @return The grammar name
077     */
078    public String getGrammarName( Grammar<?> grammar )
079    {
080        if ( grammar instanceof PagedResultsGrammar )
081        {
082            return "PAGEDSEARCH_GRAMMAR";
083        }
084
085        return "UNKNOWN GRAMMAR";
086    }
087
088
089    /**
090     * Get the string representing the state
091     * 
092     * @param state The state number
093     * @return The String representing the state
094     */
095    public String getState( int state )
096    {
097        return ( ( state == END_STATE.ordinal() ) ? "PAGED_SEARCH_END_STATE" : name() );
098    }
099
100    
101    /**
102     * {@inheritDoc}
103     */
104    public boolean isEndState()
105    {
106        return this == END_STATE;
107    }
108    
109    
110    /**
111     * {@inheritDoc}
112     */
113    public PagedResultsStates getStartState()
114    {
115        return START_STATE;
116    }
117}