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.ldap.extras.controls.syncrepl.syncState;
021
022
023import org.apache.directory.api.i18n.I18n;
024
025
026/**
027 * 
028 * This class describes the four types of states part of the syncStateValue as described in rfc4533.
029 * 
030 *  state ENUMERATED {
031 *            present (0),
032 *            add (1),
033 *            modify (2),
034 *            delete (3),
035 *            
036 *            #includes the below ApacheDS specific values
037 *            moddn(4),
038 *   }
039 *   
040 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
041 */
042public enum SyncStateTypeEnum
043{
044    PRESENT(0), ADD(1), MODIFY(2), DELETE(3), MODDN(4);
045
046    /** the internal value */
047    private int value;
048
049
050    /**
051     * Private constructor so no other instances can be created other than the
052     * public static constants in this class.
053     * 
054     * @param value the integer value of the enumeration.
055     */
056    private SyncStateTypeEnum( int value )
057    {
058        this.value = value;
059    }
060
061
062    /**
063     * @return The value associated with the current element.
064     */
065    public int getValue()
066    {
067        return value;
068    }
069
070
071    /**
072     * Get the {@link SyncStateTypeEnum} instance from an integer value.
073     * 
074     * @param value The value we want the enum element from
075     * @return The enum element associated with this integer
076     */
077    public static SyncStateTypeEnum getSyncStateType( int value )
078    {
079        if ( value == PRESENT.value )
080        {
081            return PRESENT;
082        }
083        else if ( value == ADD.value )
084        {
085            return ADD;
086        }
087        else if ( value == MODIFY.value )
088        {
089            return MODIFY;
090        }
091        else if ( value == DELETE.value )
092        {
093            return DELETE;
094        }
095        else if ( value == MODDN.value )
096        {
097            return MODDN;
098        }
099
100        throw new IllegalArgumentException( I18n.err( I18n.ERR_04163, value ) );
101    }
102
103}