Package com.unboundid.ldap.sdk.schema
Enum ObjectClassType
- java.lang.Object
-
- java.lang.Enum<ObjectClassType>
-
- com.unboundid.ldap.sdk.schema.ObjectClassType
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ObjectClassType>
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum ObjectClassType extends java.lang.Enum<ObjectClassType>
This enum defines the set of object class types that are defined in the LDAP protocol.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ABSTRACT
The object class type for abstract object classes.AUXILIARY
The object class type for auxiliary object classes.STRUCTURAL
The object class type for structural object classes.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ObjectClassType
forName(java.lang.String name)
Retrieves the object class type value with the specified name.java.lang.String
getName()
Retrieves the name of this object class type.java.lang.String
toString()
Retrieves a string representation of this object class type.static ObjectClassType
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static ObjectClassType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ABSTRACT
public static final ObjectClassType ABSTRACT
The object class type for abstract object classes. An abstract object class may only serve as the superclass for another object class, and may not appear in an entry unless at least one of its non-abstract subclasses is also included.
-
STRUCTURAL
public static final ObjectClassType STRUCTURAL
The object class type for structural object classes. An entry must have exactly one structural object class.
-
AUXILIARY
public static final ObjectClassType AUXILIARY
The object class type for auxiliary object classes. An entry may have any number of auxiliary classes (although that may potentially be restricted by DIT content rule definitions in the server).
-
-
Method Detail
-
values
public static ObjectClassType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (ObjectClassType c : ObjectClassType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ObjectClassType valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getName
@NotNull public java.lang.String getName()
Retrieves the name of this object class type.- Returns:
- The name of this object class type.
-
forName
@Nullable public static ObjectClassType forName(@NotNull java.lang.String name)
Retrieves the object class type value with the specified name.- Parameters:
name
- The name of the object class type to retrieve. It must not benull
.- Returns:
- The object class type with the specified name, or
null
if there is no type with the given name.
-
toString
@NotNull public java.lang.String toString()
Retrieves a string representation of this object class type.- Overrides:
toString
in classjava.lang.Enum<ObjectClassType>
- Returns:
- A string representation of this object class type.
-
-