Package org.ldaptive.schema

Class Syntax

java.lang.Object

org.ldaptive.AbstractFreezable

org.ldaptive.schema.AbstractSchemaElement<String>

org.ldaptive.schema.Syntax

All Implemented Interfaces:

Freezable, SchemaElement<String>

public class Syntax
extends AbstractSchemaElement<String>

Bean for an attribute syntax schema element.

   SyntaxDescription = LPAREN WSP
     numericoid                 ; object identifier
     [ SP "DESC" SP qdstring ]  ; description
     extensions WSP RPAREN      ; extensions
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Syntax.DefaultDefinitionFunction	Parses a syntax definition using a char buffer.
static class	Syntax.DefaultSchemaElementFormatter	Creates a string representation of a syntax.
static class	Syntax.RegexDefinitionFunction	Parses a syntax definition using a regular expression.

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	HASH_CODE_SEED	hash code seed.
private final String	oid	OID.

Constructor Summary

Constructors

Constructor	Description
Syntax(String s)	Creates a new attribute syntax.
Syntax(String oid, String description, Extensions extensions)	Creates a new attribute syntax.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	format()	Returns this schema element as formatted string per RFC 4512.
String	format(SchemaElementFormatter<Syntax> formatter)	Returns a string representation of this element.
String	getElementKey()	Returns the key for this element.
String	getOID()	Returns the oid.
int	hashCode()
static Syntax	parse(String definition)	Parses the supplied definition string and creates an initialized attribute syntax.
String	toString()

Methods inherited from class org.ldaptive.schema.AbstractSchemaElement

containsBooleanExtension, freeze, getDescription, getExtensions, setDescription, setExtensions

Methods inherited from class org.ldaptive.AbstractFreezable

assertMutable, freeze, freeze, isFrozen

Methods inherited from class java.lang.Object

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

Field Details

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

• Constant Field Values

oid

private final String oid

OID.

Constructor Details

Syntax

public Syntax(String s)

Creates a new attribute syntax.

Parameters:

s - oid

Syntax

public Syntax(String oid,
 String description,
 Extensions extensions)

Creates a new attribute syntax.

Parameters:

oid - oid

description - description

extensions - extensions

Method Details

getElementKey

public String getElementKey()

Description copied from interface: SchemaElement

Returns the key for this element. Typically, an OID but may also be an integer.

Returns:

element key

getOID

public String getOID()

Returns the oid.

Returns:

oid

parse

public static Syntax parse(String definition)
                    throws SchemaParseException

Parses the supplied definition string and creates an initialized attribute syntax.

Parameters:

definition - to parse

Returns:

attribute syntax

Throws:

SchemaParseException - if the supplied definition is invalid

format

public String format()

Description copied from interface: SchemaElement

Returns this schema element as formatted string per RFC 4512.

Returns:

formatted string

format

public String format(SchemaElementFormatter<Syntax> formatter)

Returns a string representation of this element.

Parameters:

formatter - to format this element

Returns:

formatted schema element

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractSchemaElement<String>

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractSchemaElement<String>

toString

public String toString()

Overrides:

toString in class Object