Package com.unboundid.directory.sdk.common.schema

Interface AttributeSyntax

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)
      Indicates whether the provided object is equal to this attribute syntax.
      ApproximateMatchingRule getDefaultApproximateMatchingRule()
      Retrieves the default approximate matching rule that will be used for attribute types with this syntax which do not explicitly specify their own approximate matching rule.
      EqualityMatchingRule getDefaultEqualityMatchingRule()
      Retrieves the default equality matching rule that will be used for attribute types with this syntax which do not explicitly specify their own equality matching rule.
      OrderingMatchingRule getDefaultOrderingMatchingRule()
      Retrieves the default ordering matching rule that will be used for attribute types with this syntax which do not explicitly specify their own ordering matching rule.
      SubstringMatchingRule getDefaultSubstringMatchingRule()
      Retrieves the default substring matching rule that will be used for attribute types with this syntax which do not explicitly specify their own substring matching rule.
      java.lang.String getDescription()
      Retrieves the description for this attribute syntax, if any.
      java.lang.String getName()
      Retrieves the name for this attribute syntax, if any.
      java.lang.String getNameOrOID()
      Retrieves the name for this attribute syntax, or the numeric OID if it does not have a name.
      java.lang.String getOID()
      Retrieves the numeric OID for this attribute syntax.
      int hashCode()
      Retrieves the hash code for this attribute syntax.
      boolean hasNameOrOID​(java.lang.String name)
      Indicates whether the provided string matches the name or numeric OID for this attribute syntax.
      java.lang.String toString()
      Retrieves a string representation of this attribute syntax.
      boolean valueIsAcceptable​(AttributeType attributeType, ByteString value, java.lang.StringBuilder invalidReason)
      Indicates whether the provided value is acceptable for use with this attribute syntax.
      boolean valueIsAcceptable​(ByteString value, java.lang.StringBuilder invalidReason)
      Indicates whether the provided value is acceptable for use with this attribute syntax.

    • Method Detail

      • getOID

        java.lang.String getOID()
        Retrieves the numeric OID for this attribute syntax.
        Returns:
        The numeric OID for this attribute syntax.

      • getName

        java.lang.String getName()
        Retrieves the name for this attribute syntax, if any.
        Returns:
        The name for this attribute syntax, or null if it does not have a name.

      • getNameOrOID

        java.lang.String getNameOrOID()
        Retrieves the name for this attribute syntax, or the numeric OID if it does not have a name.
        Returns:
        The name for this attribute syntax, or the numeric OID if it does not have a name.

      • hasNameOrOID

        boolean hasNameOrOID​(java.lang.String name)
        Indicates whether the provided string matches the name or numeric OID for this attribute syntax.
        Parameters:
        name - The name for which to make the determination.
        Returns:
        true if the provided string matches the name or numeric OID for this attribute syntax, or false if not.

      • getDescription

        java.lang.String getDescription()
        Retrieves the description for this attribute syntax, if any.
        Returns:
        The description for this attribute syntax, or null if it does not have a description.

      • getDefaultEqualityMatchingRule

        EqualityMatchingRule getDefaultEqualityMatchingRule()
        Retrieves the default equality matching rule that will be used for attribute types with this syntax which do not explicitly specify their own equality matching rule.
        Returns:
        The default equality matching rule that will be used for attribute types with this syntax, or null if there is no default equality matching rule.

      • getDefaultOrderingMatchingRule

        OrderingMatchingRule getDefaultOrderingMatchingRule()
        Retrieves the default ordering matching rule that will be used for attribute types with this syntax which do not explicitly specify their own ordering matching rule.
        Returns:
        The default ordering matching rule that will be used for attribute types with this syntax, or null if there is no default ordering matching rule.

      • getDefaultSubstringMatchingRule

        SubstringMatchingRule getDefaultSubstringMatchingRule()
        Retrieves the default substring matching rule that will be used for attribute types with this syntax which do not explicitly specify their own substring matching rule.
        Returns:
        The default substring matching rule that will be used for attribute types with this syntax, or null if there is no default substring matching rule.

      • getDefaultApproximateMatchingRule

        ApproximateMatchingRule getDefaultApproximateMatchingRule()
        Retrieves the default approximate matching rule that will be used for attribute types with this syntax which do not explicitly specify their own approximate matching rule.
        Returns:
        The default approximate matching rule that will be used for attribute types with this syntax, or null if there is no default approximate matching rule.

      • valueIsAcceptable

        boolean valueIsAcceptable​(ByteString value,
                          java.lang.StringBuilder invalidReason)
        Indicates whether the provided value is acceptable for use with this attribute syntax. NOTE: It is recommended that the valueIsAcceptable(AttributeType, ByteString, StringBuilder) version of this method be used when possible.
        Parameters:
        value - The value for which to make the determination.
        invalidReason - A buffer to which a message may be appended with information about why the given value is not acceptable.
        Returns:
        true if the provided value is acceptable for use with this attribute syntax, or false if not.

      • valueIsAcceptable

        boolean valueIsAcceptable​(AttributeType attributeType,
                          ByteString value,
                          java.lang.StringBuilder invalidReason)
        Indicates whether the provided value is acceptable for use with this attribute syntax.
        Parameters:
        attributeType - The attribute type with which the value is associated.
        value - The value for which to make the determination.
        invalidReason - A buffer to which a message may be appended with information about why the given value is not acceptable.
        Returns:
        true if the provided value is acceptable for use with this attribute syntax, or false if not.

      • hashCode

        int hashCode()
        Retrieves the hash code for this attribute syntax.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        The hash code for this attribute syntax.

      • equals

        boolean equals​(java.lang.Object o)
        Indicates whether the provided object is equal to this attribute syntax.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        o - The object for which to make the determination.
        Returns:
        true if the provided object is equal to this attribute syntax, or false if not.

      • toString

        java.lang.String toString()
        Retrieves a string representation of this attribute syntax.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this attribute syntax.