Enum SchemaElementType

    • 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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static SchemaElementType forName​(java.lang.String name)
      Retrieves the schema element type with the given name.
      java.lang.String getName()
      Retrieves the name for this schema element type.
      java.lang.String getSubschemaAttributeTypeName()
      Retrieves the name used to hold definitions for elements of this type in a subschema subentry.
      java.lang.String toString()
      Retrieves a string representation of this schema element type.
      static SchemaElementType valueOf​(java.lang.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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • 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.
      • 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 Detail

      • values

        public static SchemaElementType[] 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 (SchemaElementType c : SchemaElementType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static SchemaElementType 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 name
        java.lang.NullPointerException - if the argument is null
      • getName

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

        @NotNull
        public java.lang.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
                                                java.lang.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 java.lang.String toString()
        Retrieves a string representation of this schema element type.
        Overrides:
        toString in class java.lang.Enum<SchemaElementType>
        Returns:
        A string representation of this schema element type.