/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *  
 *    http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License. 
 *  
 */
package org.apache.directory.studio.openldap.syncrepl;


import java.text.ParseException;


/**
 * This enum implements all the possible values for the scope value.
 */
public enum Scope
{
    /** The 'sub' scope value */
    SUB("sub"),

    /** The 'one' scope value */
    ONE("one"),

    /** The 'base' scope value */
    BASE("base"),

    /** The 'subord' scope value */
    SUBORD("subord");

    /** The value */
    private String value;


    /**
     * Parses a scope string.
     *
     * @param s the string
     * @return a scope
     * @throws ParseException if an error occurs during parsing
     */
    public static Scope parse( String s ) throws ParseException
    {
        // SUB
        if ( SUB.value.equalsIgnoreCase( s ) )
        {
            return SUB;
        }
        // ONE
        else if ( ONE.value.equalsIgnoreCase( s ) )
        {
            return ONE;
        }
        // BASE
        else if ( BASE.value.equalsIgnoreCase( s ) )
        {
            return BASE;
        }
        // SUBORD
        else if ( SUBORD.value.equalsIgnoreCase( s ) )
        {
            return SUBORD;
        }
        else
        {
            throw new ParseException( "Unable to parse string '" + s + "' as a valid scope.", 0 );
        }
    }


    /**
     * Creates a new instance of Scope.
     *
     * @param value the value
     */
    private Scope( String value )
    {
        this.value = value;
    }


    /**
     * {@inheritDoc}
     */
    public String toString()
    {
        return value;
    }
}
