001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2006-2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.types;
028    
029    
030    
031    /**
032     * This enumeration defines a set of lock types that can be used when
033     * requesting that a lock be obtained for an entry or some other
034     * object.
035     */
036    @org.opends.server.types.PublicAPI(
037         stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
038         mayInstantiate=false,
039         mayExtend=false,
040         mayInvoke=true)
041    public enum LockType
042    {
043      /**
044       * The lock type that indicates that a read lock should be obtained
045       * for the associated object.
046       */
047      READ("Read"),
048    
049    
050    
051      /**
052       * The lock type that indicates that a write lock should be obtained
053       * for the associated object.
054       */
055      WRITE("Write"),
056    
057    
058    
059      /**
060       * The lock type that indicates that no lock should be obtained for
061       * the associated object.
062       */
063      NONE("None");
064    
065    
066    
067      // The human-readable name for this lock type.
068      private String name;
069    
070    
071    
072      /**
073       * Creates a new lock type element with the provided name.
074       *
075       * @param  name  The name of the lock type element to create.
076       */
077      private LockType(String name)
078      {
079        this.name = name;
080      }
081    
082    
083    
084      /**
085       * Retrieves the name of this lock type element.
086       *
087       * @return  The name of this lock type element.
088       */
089      public String getName()
090      {
091        return name;
092      }
093    
094    
095    
096      /**
097       * Retrieves a string representation of this lock type element.
098       *
099       * @return  A string representation of this lock type element.
100       */
101      public String toString()
102      {
103        return name;
104      }
105    }
106