Package com.unboundid.ldap.sdk.schema

Class DITStructureRuleDefinition

java.lang.Object
com.unboundid.ldap.sdk.schema.SchemaElement
com.unboundid.ldap.sdk.schema.DITStructureRuleDefinition
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class DITStructureRuleDefinition extends SchemaElement
This class provides a data structure that describes an LDAP DIT structure rule schema element.
See Also:

  • Constructor Details

    • DITStructureRuleDefinition

      public DITStructureRuleDefinition(@NotNull String s) throws LDAPException
      Creates a new DIT structure rule from the provided string representation.
      Parameters:
      s - The string representation of the DIT structure rule to create, using the syntax described in RFC 4512 section 4.1.7.1. It must not be null.
      Throws:
      LDAPException - If the provided string cannot be decoded as a DIT structure rule definition.

    • DITStructureRuleDefinition

      public DITStructureRuleDefinition(int ruleID, @Nullable String name, @Nullable String description, @NotNull String nameFormID, @Nullable Integer superiorRuleID, @Nullable Map<String,String[]> extensions)
      Creates a new DIT structure rule with the provided information.
      Parameters:
      ruleID - The rule ID for this DIT structure rule.
      name - The name for this DIT structure rule. It may be null if the DIT structure rule should only be referenced by rule ID.
      description - The description for this DIT structure rule. It may be null if there is no description.
      nameFormID - The name or OID of the name form with which this DIT structure rule is associated. It must not be null.
      superiorRuleID - The superior rule ID for this DIT structure rule. It may be null if there are no superior rule IDs.
      extensions - The set of extensions for this DIT structure rule. It may be null or empty if there are no extensions.

    • DITStructureRuleDefinition

      public DITStructureRuleDefinition(int ruleID, @Nullable String[] names, @Nullable String description, boolean isObsolete, @NotNull String nameFormID, @Nullable int[] superiorRuleIDs, @Nullable Map<String,String[]> extensions)
      Creates a new DIT structure rule with the provided information.
      Parameters:
      ruleID - The rule ID for this DIT structure rule.
      names - The set of names for this DIT structure rule. It may be null or empty if the DIT structure rule should only be referenced by rule ID.
      description - The description for this DIT structure rule. It may be null if there is no description.
      isObsolete - Indicates whether this DIT structure rule is declared obsolete.
      nameFormID - The name or OID of the name form with which this DIT structure rule is associated. It must not be null.
      superiorRuleIDs - The superior rule IDs for this DIT structure rule. It may be null or empty if there are no superior rule IDs.
      extensions - The set of extensions for this DIT structure rule. It may be null or empty if there are no extensions.

  • Method Details

    • getRuleID

      public int getRuleID()
      Retrieves the rule ID for this DIT structure rule.
      Returns:
      The rule ID for this DIT structure rule.

    • getNames

      @NotNull public String[] getNames()
      Retrieves the set of names for this DIT structure rule.
      Returns:
      The set of names for this DIT structure rule, or an empty array if it does not have any names.

    • getNameOrRuleID

      @NotNull public String getNameOrRuleID()
      Retrieves the primary name that can be used to reference this DIT structure rule. If one or more names are defined, then the first name will be used. Otherwise, the string representation of the rule ID will be returned.
      Returns:
      The primary name that can be used to reference this DIT structure rule.

    • hasNameOrRuleID

      public boolean hasNameOrRuleID(@NotNull String s)
      Indicates whether the provided string matches the rule ID or any of the names for this DIT structure rule.
      Parameters:
      s - The string for which to make the determination. It must not be null.
      Returns:
      true if the provided string matches the rule ID or any of the names for this DIT structure rule, or false if not.

    • getDescription

      @Nullable public String getDescription()
      Retrieves the description for this DIT structure rule, if available.
      Returns:
      The description for this DIT structure rule, or null if there is no description defined.

    • isObsolete

      public boolean isObsolete()
      Indicates whether this DIT structure rule is declared obsolete.
      Returns:
      true if this DIT structure rule is declared obsolete, or false if it is not.

    • getNameFormID

      @NotNull public String getNameFormID()
      Retrieves the name or OID of the name form with which this DIT structure rule is associated.
      Returns:
      The name or OID of the name form with which this DIT structure rule is associated.

    • getSuperiorRuleIDs

      @NotNull public int[] getSuperiorRuleIDs()
      Retrieves the rule IDs of the superior rules for this DIT structure rule.
      Returns:
      The rule IDs of the superior rules for this DIT structure rule, or an empty array if there are no superior rule IDs.

    • getExtensions

      @NotNull public Map<String,String[]> getExtensions()
      Retrieves the set of extensions for this DIT structure rule. They will be mapped from the extension name (which should start with "X-") to the set of values for that extension.
      Returns:
      The set of extensions for this DIT structure rule.

    • getSchemaElementType

      @NotNull public SchemaElementType getSchemaElementType()
      Retrieves the type of schema element that this object represents.
      Specified by:
      getSchemaElementType in class SchemaElement
      Returns:
      The type of schema element that this object represents.

    • hashCode

      public int hashCode()
      Retrieves a hash code for this schema element.
      Specified by:
      hashCode in class SchemaElement
      Returns:
      A hash code for this schema element.

    • equals

      public boolean equals(@Nullable Object o)
      Indicates whether the provided object is equal to this schema element.
      Specified by:
      equals in class SchemaElement
      Parameters:
      o - The object for which to make the determination.
      Returns:
      true if the provided object may be considered equal to this schema element, or false if not.

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this DIT structure rule definition, in the format described in RFC 4512 section 4.1.7.1.
      Specified by:
      toString in class SchemaElement
      Returns:
      A string representation of this DIT structure rule definition.