Package org.ldaptive.schema

Class MatchingRule

java.lang.Object
org.ldaptive.schema.AbstractSchemaElement
org.ldaptive.schema.AbstractNamedSchemaElement
org.ldaptive.schema.MatchingRule
All Implemented Interfaces:
SchemaElement
public class MatchingRule extends AbstractNamedSchemaElement
Bean for an matching rule schema element. 
   MatchingRuleDescription = LPAREN WSP
     numericoid                 ; object identifier
     [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
     [ SP "DESC" SP qdstring ]  ; description
     [ SP "OBSOLETE" ]          ; not active
     SP "SYNTAX" SP numericoid  ; assertion syntax
     extensions WSP RPAREN      ; extensions

  • Field Details

    • HASH_CODE_SEED

      private static final int HASH_CODE_SEED
      hash code seed.
      See Also:

    • oid

      private final String oid
      OID.

    • syntaxOID

      private String syntaxOID
      Syntax OID.

  • Constructor Details

    • MatchingRule

      public MatchingRule(String s)
      Creates a new matching rule.
      Parameters:
      s - oid

    • MatchingRule

      public MatchingRule(String oid, String[] names, String description, boolean obsolete, String syntaxOID, Extensions extensions)
      Creates a new matching rule.
      Parameters:
      oid - oid
      names - names
      description - description
      obsolete - obsolete
      syntaxOID - syntax OID
      extensions - extensions

  • Method Details

    • getOID

      public String getOID()
      Returns the oid.
      Returns:
      oid

    • getSyntaxOID

      public String getSyntaxOID()
      Returns the syntax oid.
      Returns:
      syntax oid

    • setSyntaxOID

      public void setSyntaxOID(String s)
      Sets the syntax oid.
      Parameters:
      s - syntax oid

    • parse

      public static MatchingRule parse(String definition) throws SchemaParseException
      Parses the supplied definition string and creates an initialized matching rule.
      Parameters:
      definition - to parse
      Returns:
      matching rule
      Throws:
      SchemaParseException - if the supplied definition is invalid

    • format

      public String format()
      Description copied from interface: SchemaElement
      Returns this schema element as formatted string per RFC 4512.
      Returns:
      formatted string

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class AbstractSchemaElement

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in class AbstractSchemaElement

    • toString

      public String toString()
      Overrides:
      toString in class Object