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 the set of possible objectclass types that
033     * may be used, as defined in RFC 2252.
034     */
035    @org.opends.server.types.PublicAPI(
036         stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
037         mayInstantiate=false,
038         mayExtend=false,
039         mayInvoke=true)
040    public enum ObjectClassType
041    {
042      /**
043       * The objectclass type that to use for classes declared "abstract".
044       */
045      ABSTRACT("ABSTRACT"),
046    
047    
048    
049      /**
050       * The objectclass type that to use for classes declared
051       * "structural".
052       */
053      STRUCTURAL("STRUCTURAL"),
054    
055    
056    
057      /**
058       * The objectclass type that to use for classes declared
059       * "auxiliary".
060       */
061      AUXILIARY("AUXILIARY");
062    
063    
064    
065      // The string representation of this objectclass type.
066      String typeString;
067    
068    
069    
070      /**
071       * Creates a new objectclass type with the provided string
072       * representation.
073       *
074       * @param  typeString  The string representation for this
075       *                     objectclass type.
076       */
077      private ObjectClassType(String typeString)
078      {
079        this.typeString = typeString;
080      }
081    
082    
083    
084      /**
085       * Retrieves a string representation of this objectclass type.
086       *
087       * @return  A string representation of this objectclass type.
088       */
089      public String toString()
090      {
091        return typeString;
092      }
093    }
094