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
021package org.apache.directory.api.ldap.extras.controls;
022
023
024/**
025 * The type of MODDN modification. One of MOVE, RENAME or MOVE_AND_RENAME
026 *
027 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
028 */
029public enum SyncModifyDnType
030{
031    /** A Move operation */
032    MOVE(0),
033    
034    /** A Rename operation */
035    RENAME(1),
036    
037    /** A Move and Rename operation */
038    MOVE_AND_RENAME(2);
039
040    /** Internal value for each tag */
041    private int value;
042
043
044    /**
045     * Creates the value
046     */
047    SyncModifyDnType( int value )
048    {
049        this.value = value;
050    }
051
052
053    /**
054     * @return The value associated with the current element.
055     */
056    public int getValue()
057    {
058        return value;
059    }
060
061
062    /**
063     * Get the instance from it's interger value
064     * @param value The value we are looking for 
065     * @return The associated value
066     */
067    public static SyncModifyDnType getModifyDnType( int value )
068    {
069        switch ( value )
070        {
071            case 0:
072                return MOVE;
073
074            case 1:
075                return RENAME;
076
077            case 2:
078                return MOVE_AND_RENAME;
079
080            default:
081                throw new IllegalArgumentException( "unknown modify dn operantion type " + value );
082        }
083    }
084}