Package com.unboundid.ldap.sdk.schema

Enum SchemaElementType

java.lang.Object
java.lang.Enum<SchemaElementType>
com.unboundid.ldap.sdk.schema.SchemaElementType
All Implemented Interfaces:
Serializable, Comparable<SchemaElementType>, java.lang.constant.Constable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum SchemaElementType extends Enum<SchemaElementType>
This enum defines the types of elements that can make up an LDAP schema.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ATTRIBUTE_SYNTAX
    The schema element type used to indicate the type of data that an attribute of a given type can hold.
    ATTRIBUTE_TYPE
    The schema element type used to hold provide information about an attribute.
    DIT_CONTENT_RULE
    The schema element type used to define additional constraints about attributes with a given structural object class, including allowed auxiliary object classes and required, optional, and prohibited attribute types.
    DIT_STRUCTURE_RULE
    The schema element type used to define allowed hierarchical relationships between entries with different types of structural object classes.
    MATCHING_RULE
    The schema element type used to indicate how to perform matching operations against values for attributes of a given type.
    MATCHING_RULE_USE
    The schema element type that may be used to restrict the set of attribute types with which a matching rule may be used.
    NAME_FORM
    The schema element type used to define the types of attributes that must and may be present in the RDN of an entry with a given structural object class.
    OBJECT_CLASS
    The schema element type used to define the sets of attributes that may be present in different types of entries.

  • Method Summary

    Modifier and Type
    Method
    Description
    static SchemaElementType
    forName(String name)
    Retrieves the schema element type with the given name.
    String
    getName()
    Retrieves the name for this schema element type.
    String
    getSubschemaAttributeTypeName()
    Retrieves the name used to hold definitions for elements of this type in a subschema subentry.
    String
    toString()
    Retrieves a string representation of this schema element type.
    static SchemaElementType
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static SchemaElementType[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ATTRIBUTE_SYNTAX

      public static final SchemaElementType ATTRIBUTE_SYNTAX
      The schema element type used to indicate the type of data that an attribute of a given type can hold.

    • MATCHING_RULE

      public static final SchemaElementType MATCHING_RULE
      The schema element type used to indicate how to perform matching operations against values for attributes of a given type.

    • ATTRIBUTE_TYPE

      public static final SchemaElementType ATTRIBUTE_TYPE
      The schema element type used to hold provide information about an attribute.

    • OBJECT_CLASS

      public static final SchemaElementType OBJECT_CLASS
      The schema element type used to define the sets of attributes that may be present in different types of entries.

    • NAME_FORM

      public static final SchemaElementType NAME_FORM
      The schema element type used to define the types of attributes that must and may be present in the RDN of an entry with a given structural object class.

    • DIT_CONTENT_RULE

      public static final SchemaElementType DIT_CONTENT_RULE
      The schema element type used to define additional constraints about attributes with a given structural object class, including allowed auxiliary object classes and required, optional, and prohibited attribute types.

    • DIT_STRUCTURE_RULE

      public static final SchemaElementType DIT_STRUCTURE_RULE
      The schema element type used to define allowed hierarchical relationships between entries with different types of structural object classes.

    • MATCHING_RULE_USE

      public static final SchemaElementType MATCHING_RULE_USE
      The schema element type that may be used to restrict the set of attribute types with which a matching rule may be used.

  • Method Details

    • values

      public static SchemaElementType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static SchemaElementType valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getName

      @NotNull public String getName()
      Retrieves the name for this schema element type.
      Returns:
      The name for this schema element type.

    • getSubschemaAttributeTypeName

      @NotNull public String getSubschemaAttributeTypeName()
      Retrieves the name used to hold definitions for elements of this type in a subschema subentry.
      Returns:
      The name used to hold definitions for elements of this type in a subschema subentry.

    • forName

      @Nullable public static SchemaElementType forName(@NotNull String name)
      Retrieves the schema element type with the given name.
      Parameters:
      name - The name for the schema element type to retrieve. It must not be null.
      Returns:
      The schema element type with the given name, or null if there is no schema element type with that name.

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this schema element type.
      Overrides:
      toString in class Enum<SchemaElementType>
      Returns:
      A string representation of this schema element type.