org.opends.server.types

Class LDAPSyntaxDescription

java.lang.Object

org.opends.server.types.LDAPSyntaxDescription

All Implemented Interfaces:

SchemaFileElement

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public final class LDAPSyntaxDescription
extends Object
implements SchemaFileElement

This class defines a data structure for storing and interacting with an ldap syntax, which defines the custom ldap syntaxes.

Constructor Summary

Constructors

Constructor and Description
LDAPSyntaxDescription(String definition, String oid, Map<String,List<String>> extraProperties) Creates a new ldap syntax definition with the provided information.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o) Indicates whether the provided object is equal to this ldap syntax.
Map<String,List<String>>	getExtraProperties() Retrieves a mapping between the names of any extra non-standard properties that may be associated with this ldap syntax description and the value for that property.
List<String>	getExtraProperty(String propertyName) Retrieves the value of the specified "extra" property for this ldap syntax description.
String	getOID() Returns the oid.
int	hashCode() Retrieves the hash code for this ldap syntax description.
void	setExtraProperty(String name, List<String> values) Specifies the provided "extra" property for this ldap syntax description.
String	toString() Retrieves the string representation of this ldap syntax description in the form specified in RFC 2252.

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPSyntaxDescription

public LDAPSyntaxDescription(String definition,
                     String oid,
                     Map<String,List<String>> extraProperties)

Creates a new ldap syntax definition with the provided information.

Parameters:

definition - The definition string used to create this ldap syntax. It must not be null.

oid - oid of the syntax

extraProperties - A set of extra properties for this ldap syntax description.

Method Detail

getOID

public String getOID()

Returns the oid.

Returns:

the oid

getExtraProperties

public Map<String,List<String>> getExtraProperties()

Retrieves a mapping between the names of any extra non-standard properties that may be associated with this ldap syntax description and the value for that property.

Specified by:

getExtraProperties in interface SchemaFileElement

Returns:

A mapping between the names of any extra non-standard properties that may be associated with this ldap syntax description and the value for that property.

getExtraProperty

public List<String> getExtraProperty(String propertyName)

Retrieves the value of the specified "extra" property for this ldap syntax description.

Parameters:

propertyName - The name of the "extra" property for which to retrieve the value.

Returns:

The value of the specified "extra" property for this ldap syntax description, or null if no such property is defined.

setExtraProperty

public void setExtraProperty(String name,
                    List<String> values)

Specifies the provided "extra" property for this ldap syntax description.

Parameters:

name - The name for the "extra" property. It must not be null.

values - The set of value for the "extra" property, or null if the property is to be removed.

equals

public boolean equals(Object o)

Indicates whether the provided object is equal to this ldap syntax. The object will be considered equal if it is a ldap syntax with the same OID as the current ldap syntax description.

Overrides:

equals in class Object

Parameters:

o - The object for which to make the determination.

Returns:

true if the provided object is equal to this ldap syntax description, or true if not.

hashCode

public int hashCode()

Retrieves the hash code for this ldap syntax description. It will be based on the sum of the bytes of the OID.

Overrides:

hashCode in class Object

Returns:

The hash code for this ldap syntax description.

toString

public String toString()

Retrieves the string representation of this ldap syntax description in the form specified in RFC 2252.

Overrides:

toString in class Object

Returns:

The string representation of this ldap syntax in the form specified in RFC 2252.