Package com.unboundid.ldap.sdk.schema

Class MatchingRuleDefinition

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

  • Constructor Details

    • MatchingRuleDefinition

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

    • MatchingRuleDefinition

      public MatchingRuleDefinition(@NotNull String oid, @Nullable String name, @Nullable String description, @NotNull String syntaxOID, @Nullable Map<String,String[]> extensions)
      Creates a new matching rule with the provided information.
      Parameters:
      oid - The OID for this matching rule. It must not be null.
      name - The names for this matching rule. It may be null if the matching rule should only be referenced by OID.
      description - The description for this matching rule. It may be null if there is no description.
      syntaxOID - The syntax OID for this matching rule. It must not be null.
      extensions - The set of extensions for this matching rule. It may be null or empty if there should not be any extensions.

    • MatchingRuleDefinition

      public MatchingRuleDefinition(@NotNull String oid, @Nullable String[] names, @Nullable String description, boolean isObsolete, @NotNull String syntaxOID, @Nullable Map<String,String[]> extensions)
      Creates a new matching rule with the provided information.
      Parameters:
      oid - The OID for this matching rule. It must not be null.
      names - The set of names for this matching rule. It may be null or empty if the matching rule should only be referenced by OID.
      description - The description for this matching rule. It may be null if there is no description.
      isObsolete - Indicates whether this matching rule is declared obsolete.
      syntaxOID - The syntax OID for this matching rule. It must not be null.
      extensions - The set of extensions for this matching rule. It may be null or empty if there should not be any extensions.

  • Method Details

    • getOID

      @NotNull public String getOID()
      Retrieves the OID for this matching rule.
      Returns:
      The OID for this matching rule.

    • getNames

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

    • getNameOrOID

      @NotNull public String getNameOrOID()
      Retrieves the primary name that can be used to reference this matching rule. If one or more names are defined, then the first name will be used. Otherwise, the OID will be returned.
      Returns:
      The primary name that can be used to reference this matching rule.

    • hasNameOrOID

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

    • getDescription

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

    • isObsolete

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

    • getSyntaxOID

      @NotNull public String getSyntaxOID()
      Retrieves the OID of the syntax for this matching rule.
      Returns:
      The OID of the syntax for this matching rule.

    • getExtensions

      @NotNull public Map<String,String[]> getExtensions()
      Retrieves the set of extensions for this matching 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 matching 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 matching rule definition, in the format described in RFC 4512 section 4.1.3.
      Specified by:
      toString in class SchemaElement
      Returns:
      A string representation of this matching rule definition.