Package com.unboundid.ldap.sdk.schema

Class AttributeSyntaxDefinition

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

  • Constructor Details

    • AttributeSyntaxDefinition

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

    • AttributeSyntaxDefinition

      public AttributeSyntaxDefinition(@NotNull String oid, @Nullable String description, @Nullable Map<String,String[]> extensions)
      Creates a new attribute syntax use with the provided information.
      Parameters:
      oid - The OID for this attribute syntax. It must not be null.
      description - The description for this attribute syntax. It may be null if there is no description.
      extensions - The set of extensions for this attribute syntax. 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 attribute syntax.
      Returns:
      The OID for this attribute syntax.

    • getDescription

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

    • getExtensions

      @NotNull public Map<String,String[]> getExtensions()
      Retrieves the set of extensions for this matching rule use. 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 use.

    • 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 attribute syntax, in the format described in RFC 4512 section 4.1.5.
      Specified by:
      toString in class SchemaElement
      Returns:
      A string representation of this attribute syntax definition.