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:

java.io.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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AttributeSyntaxDefinition(java.lang.String s) Creates a new attribute syntax from the provided string representation.
AttributeSyntaxDefinition(java.lang.String oid, java.lang.String description, java.util.Map<java.lang.String,java.lang.String[]> extensions) Creates a new attribute syntax use with the provided information.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Indicates whether the provided object is equal to this schema element.
java.lang.String	getDescription() Retrieves the description for this attribute syntax, if available.
java.util.Map<java.lang.String,java.lang.String[]>	getExtensions() Retrieves the set of extensions for this matching rule use.
java.lang.String	getOID() Retrieves the OID for this attribute syntax.
SchemaElementType	getSchemaElementType() Retrieves the type of schema element that this object represents.
int	hashCode() Retrieves a hash code for this schema element.
java.lang.String	toString() Retrieves a string representation of this attribute syntax, in the format described in RFC 4512 section 4.1.5.

Methods inherited from class com.unboundid.ldap.sdk.schema.SchemaElement

allowEmptyDescription, extensionsEqual, setAllowEmptyDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeSyntaxDefinition

public AttributeSyntaxDefinition(@NotNull
                                 java.lang.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
                                 java.lang.String oid,
                                 @Nullable
                                 java.lang.String description,
                                 @Nullable
                                 java.util.Map<java.lang.String,java.lang.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 Detail

getOID

@NotNull
public java.lang.String getOID()

Retrieves the OID for this attribute syntax.

Returns:

The OID for this attribute syntax.

getDescription

@Nullable
public java.lang.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 java.util.Map<java.lang.String,java.lang.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
                      java.lang.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 java.lang.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.