Package org.forgerock.opendj.ldap.schema

Class MatchingRuleUse

java.lang.Object
org.forgerock.opendj.ldap.schema.MatchingRuleUse
All Implemented Interfaces:
SchemaElement
public final class MatchingRuleUse extends Object
This class defines a data structure for storing and interacting with a matching rule use definition, which may be used to restrict the set of attribute types that may be used for a given matching rule.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    MatchingRuleUse.Builder
    A fluent API for incrementally constructing matching rule uses.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
    Returns true if the provided object is a matching rule use having the same numeric OID as this matching rule use.
    Set<AttributeType>
    getAttributes()
    Returns an unmodifiable set containing the attributes associated with this matching rule use.
    final String
    getDescription()
    Returns the description of this schema element, or the empty string if it does not have a description.
    final Map<String,List<String>>
    getExtraProperties()
    Returns an unmodifiable map containing all of the extra properties associated with this schema element.
    MatchingRule
    getMatchingRule()
    Returns the matching rule for this matching rule use.
    String
    getMatchingRuleOid()
    Returns the matching rule OID for this schema definition.
    String
    getNameOrOid()
    Returns the name or matching rule OID for this schema definition.
    List<String>
    getNames()
    Returns an unmodifiable list containing the user-defined names that may be used to reference this schema definition.
    boolean
    hasAttribute(AttributeType attributeType)
    Indicates whether the provided attribute type is referenced by this matching rule use.
    int
    hashCode()
    Returns the hash code for this matching rule use.
    boolean
    hasName(String name)
    Indicates whether this schema definition has the specified name.
    boolean
    hasNameOrOid(String value)
    Indicates whether this schema definition has the specified name or matching rule OID.
    boolean
    isObsolete()
    Indicates whether this schema definition is declared "obsolete".
    final String
    toString()
    Returns the string representation of this schema element as defined in RFC 2252.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • equals

      public boolean equals(Object o)
      Returns true if the provided object is a matching rule use having the same numeric OID as this matching rule use.
      Parameters:
      o - The object to be compared.
      Returns:
      true if the provided object is a matching rule use having the same numeric OID as this matching rule use.

    • getAttributes

      public Set<AttributeType> getAttributes()
      Returns an unmodifiable set containing the attributes associated with this matching rule use.
      Returns:
      An unmodifiable set containing the attributes associated with this matching rule use.

    • getMatchingRule

      public MatchingRule getMatchingRule()
      Returns the matching rule for this matching rule use.
      Returns:
      The matching rule for this matching rule use.

    • getMatchingRuleOid

      public String getMatchingRuleOid()
      Returns the matching rule OID for this schema definition.
      Returns:
      The OID for this schema definition.

    • getNameOrOid

      public String getNameOrOid()
      Returns the name or matching rule OID for this schema definition. If it has one or more names, then the primary name will be returned. If it does not have any names, then the OID will be returned.
      Returns:
      The name or OID for this schema definition.

    • getNames

      public List<String> getNames()
      Returns an unmodifiable list containing the user-defined names that may be used to reference this schema definition.
      Returns:
      Returns an unmodifiable list containing the user-defined names that may be used to reference this schema definition.

    • hasAttribute

      public boolean hasAttribute(AttributeType attributeType)
      Indicates whether the provided attribute type is referenced by this matching rule use.
      Parameters:
      attributeType - The attribute type for which to make the determination.
      Returns:
      true if the provided attribute type is referenced by this matching rule use, or false if it is not.

    • hashCode

      public int hashCode()
      Returns the hash code for this matching rule use. It will be calculated as the hash code of the numeric OID.
      Returns:
      The hash code for this matching rule use.

    • hasName

      public boolean hasName(String name)
      Indicates whether this schema definition has the specified name.
      Parameters:
      name - The name for which to make the determination.
      Returns:
      true if the specified name is assigned to this schema definition, or false if not.

    • hasNameOrOid

      public boolean hasNameOrOid(String value)
      Indicates whether this schema definition has the specified name or matching rule OID.
      Parameters:
      value - The value for which to make the determination.
      Returns:
      true if the provided value matches the OID or one of the names assigned to this schema definition, or false if not.

    • isObsolete

      public boolean isObsolete()
      Indicates whether this schema definition is declared "obsolete".
      Returns:
      true if this schema definition is declared "obsolete", or false if not.

    • getDescription

      public final String getDescription()
      Description copied from interface: SchemaElement
      Returns the description of this schema element, or the empty string if it does not have a description.
      Specified by:
      getDescription in interface SchemaElement
      Returns:
      The description of this schema element, or the empty string if it does not have a description.

    • getExtraProperties

      public final Map<String,List<String>> getExtraProperties()
      Description copied from interface: SchemaElement
      Returns an unmodifiable map containing all of the extra properties associated with this schema element.
      Specified by:
      getExtraProperties in interface SchemaElement
      Returns:
      An unmodifiable map containing all of the extra properties associated with this schema element.

    • toString

      public final String toString()
      Returns the string representation of this schema element as defined in RFC 2252.
      Overrides:
      toString in class Object
      Returns:
      The string representation of this schema element as defined in RFC 2252.