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

Interface AttributeType

    • 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 type.
      ApproximateMatchingRule getApproximateMatchingRule()
      Retrieves the approximate matching rule for this attribute type, if any.
      java.lang.String getDescription()
      Retrieves the description for this attribute type, if any.
      EqualityMatchingRule getEqualityMatchingRule()
      Retrieves the equality matching rule for this attribute type, if any.
      java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getExtensions()
      Retrieves a map of all defined extensions for this attribute type.
      java.lang.String getNameOrOID()
      Retrieves the primary name for this attribute type, or the numeric OID if no names are defined.
      java.util.List<java.lang.String> getNames()
      Retrieves the list of names for this attribute type, if any.
      java.lang.String getOID()
      Retrieves the numeric OID for this attribute type.
      OrderingMatchingRule getOrderingMatchingRule()
      Retrieves the ordering matching rule for this attribute type, if any.
      java.lang.String getSchemaFileName()
      Retrieves the name of the schema file in which this attribute type is defined.
      SubstringMatchingRule getSubstringMatchingRule()
      Retrieves the substring matching rule for this attribute type, if any.
      AttributeType getSuperiorType()
      Retrieves the superior type for this attribute type, if any.
      AttributeSyntax getSyntax()
      Retrieves the attribute syntax for this attribute type.
      AttributeUsage getUsage()
      Retrieves the usage for this attribute type.
      int hashCode()
      Retrieves a hash code for this attribute type.
      boolean hasNameOrOID​(java.lang.String name)
      Indicates whether the provided string is equal to the OID or any of the defined names for this attribute type.
      boolean isCollective()
      Indicates whether this attribute type is declared collective in the server schema.
      boolean isNoUserModification()
      Indicates whether this attribute type is declared NO-USER-MODIFICATION in the server schema.
      boolean isObsolete()
      Indicates whether this attribute type is declared obsolete in the server schema.
      boolean isOperational()
      Indicates whether this attribute type has an operational usage.
      boolean isSingleValued()
      Indicates whether this attribute type is declared single-valued in the server schema.
      java.lang.String toString()
      Retrieves a string representation of this attribute type definition.

    • Method Detail

      • getOID

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

      • getNames

        java.util.List<java.lang.String> getNames()
        Retrieves the list of names for this attribute type, if any.
        Returns:
        The list of names for this attribute type, or an empty list if there are no user-defined names.

      • getNameOrOID

        java.lang.String getNameOrOID()
        Retrieves the primary name for this attribute type, or the numeric OID if no names are defined.
        Returns:
        The primary name or OID for this attribute type.

      • hasNameOrOID

        boolean hasNameOrOID​(java.lang.String name)
        Indicates whether the provided string is equal to the OID or any of the defined names for this attribute type.
        Parameters:
        name - The name for which to make the determination.
        Returns:
        true if the provided string matches the OID or one of the names for this attribute type, or false if not.

      • getDescription

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

      • getSuperiorType

        AttributeType getSuperiorType()
        Retrieves the superior type for this attribute type, if any.
        Returns:
        The superior type for this attribute type, or null if this attribute type does not have a superior type.

      • getSyntax

        AttributeSyntax getSyntax()
        Retrieves the attribute syntax for this attribute type.
        Returns:
        The attribute syntax for this attribute type.

      • getEqualityMatchingRule

        EqualityMatchingRule getEqualityMatchingRule()
        Retrieves the equality matching rule for this attribute type, if any.
        Returns:
        The equality matching rule for this attribute type, or null if there is no equality matching rule for this attribute type.

      • getOrderingMatchingRule

        OrderingMatchingRule getOrderingMatchingRule()
        Retrieves the ordering matching rule for this attribute type, if any.
        Returns:
        The ordering matching rule for this attribute type, or null if there is no ordering matching rule for this attribute type.

      • getSubstringMatchingRule

        SubstringMatchingRule getSubstringMatchingRule()
        Retrieves the substring matching rule for this attribute type, if any.
        Returns:
        The substring matching rule for this attribute type, or null if there is no substring matching rule for this attribute type.

      • getApproximateMatchingRule

        ApproximateMatchingRule getApproximateMatchingRule()
        Retrieves the approximate matching rule for this attribute type, if any.
        Returns:
        The approximate matching rule for this attribute type, or null if there is no approximate matching rule for this attribute type.

      • getUsage

        AttributeUsage getUsage()
        Retrieves the usage for this attribute type.
        Returns:
        The usage for this attribute type.

      • isOperational

        boolean isOperational()
        Indicates whether this attribute type has an operational usage.
        Returns:
        true if this attribute type has an operational usage, or false if not.

      • isSingleValued

        boolean isSingleValued()
        Indicates whether this attribute type is declared single-valued in the server schema.
        Returns:
        true if this attribute type is declared single-valued in the server schema, or false if not.

      • isCollective

        boolean isCollective()
        Indicates whether this attribute type is declared collective in the server schema.
        Returns:
        true if this attribute type is declared collective in the server schema, or false if not.

      • isObsolete

        boolean isObsolete()
        Indicates whether this attribute type is declared obsolete in the server schema.
        Returns:
        true if this attribute type is declared obsolete in the server schema, or false if not.

      • isNoUserModification

        boolean isNoUserModification()
        Indicates whether this attribute type is declared NO-USER-MODIFICATION in the server schema.
        Returns:
        true if this attribute type is declared NO-USER-MODIFICATION in the server schema, or false if not.

      • getExtensions

        java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getExtensions()
        Retrieves a map of all defined extensions for this attribute type.
        Returns:
        A map of all defined extensions for this attribute type.

      • getSchemaFileName

        java.lang.String getSchemaFileName()
        Retrieves the name of the schema file in which this attribute type is defined.
        Returns:
        The name of the schema file in which this attribute type is defined.

      • equals

        boolean equals​(java.lang.Object o)
        Indicates whether the provided object is equal to this attribute type.
        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 type, or false if not.

      • hashCode

        int hashCode()
        Retrieves a hash code for this attribute type.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        A hash code for this attribute type.

      • toString

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