org.ldaptive.schema

Class NameForm

java.lang.Object

org.ldaptive.schema.AbstractSchemaElement

org.ldaptive.schema.AbstractNamedSchemaElement

org.ldaptive.schema.NameForm

All Implemented Interfaces:

SchemaElement

public class NameForm
extends AbstractNamedSchemaElement

Bean for a name form schema element.

   NameFormDescription = LPAREN WSP
     numericoid                 ; object identifier
     [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
     [ SP "DESC" SP qdstring ]  ; description
     [ SP "OBSOLETE" ]          ; not active
     SP "OC" SP oid             ; structural object class
     SP "MUST" SP oids          ; attribute types
     [ SP "MAY" SP oids ]       ; attribute types
     extensions WSP RPAREN      ; extensions
 

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.regex.Pattern	DEFINITION_PATTERN Pattern to match definitions.
private static int	HASH_CODE_SEED hash code seed.
private java.lang.String	oid OID.
private java.lang.String[]	optionalAttributes Optional attributes.
private java.lang.String[]	requiredAttributes Required attributes.
private java.lang.String	structuralClass Structural object class.

Fields inherited from class org.ldaptive.schema.AbstractSchemaElement

NO_WSP_REGEX, WSP_REGEX

Constructor Summary

Constructors

Constructor and Description
NameForm(java.lang.String s) Creates a new name form.
NameForm(java.lang.String oid, java.lang.String[] names, java.lang.String description, boolean obsolete, java.lang.String structuralClass, java.lang.String[] requiredAttributes, java.lang.String[] optionalAttributes, Extensions extensions) Creates a new name form.

Method Summary

Modifier and Type	Method and Description
java.lang.String	format() Returns this schema element as formatted string per RFC 4512.
java.lang.String	getOID() Returns the oid.
java.lang.String[]	getOptionalAttributes() Returns the optional attributes.
java.lang.String[]	getRequiredAttributes() Returns the required attributes.
java.lang.String	getStructuralClass() Returns the structural object class.
int	hashCode()
static NameForm	parse(java.lang.String definition) Parses the supplied definition string and creates an initialized name form.
void	setOptionalAttributes(java.lang.String[] s) Sets the optional attributes.
void	setRequiredAttributes(java.lang.String[] s) Sets the required attributes.
void	setStructuralClass(java.lang.String s) Sets the structural object class.
java.lang.String	toString()

Methods inherited from class org.ldaptive.schema.AbstractNamedSchemaElement

getName, getNames, hasName, isObsolete, setNames, setObsolete

Methods inherited from class org.ldaptive.schema.AbstractSchemaElement

containsBooleanExtension, equals, getDescription, getExtensions, setDescription, setExtensions

Methods inherited from class java.lang.Object

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

Field Detail

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

Constant Field Values

DEFINITION_PATTERN

private static final java.util.regex.Pattern DEFINITION_PATTERN

Pattern to match definitions.

oid

private final java.lang.String oid

OID.

structuralClass

private java.lang.String structuralClass

Structural object class.

requiredAttributes

private java.lang.String[] requiredAttributes

Required attributes.

optionalAttributes

private java.lang.String[] optionalAttributes

Optional attributes.

Constructor Detail

NameForm

public NameForm(java.lang.String s)

Creates a new name form.

Parameters:

s - oid

NameForm

public NameForm(java.lang.String oid,
                java.lang.String[] names,
                java.lang.String description,
                boolean obsolete,
                java.lang.String structuralClass,
                java.lang.String[] requiredAttributes,
                java.lang.String[] optionalAttributes,
                Extensions extensions)

Creates a new name form.

Parameters:

oid - oid

names - names

description - description

obsolete - obsolete

structuralClass - structural object class

requiredAttributes - required attributes

optionalAttributes - optional attributes

extensions - extensions

Method Detail

getOID

public java.lang.String getOID()

Returns the oid.

Returns:

oid

getStructuralClass

public java.lang.String getStructuralClass()

Returns the structural object class.

Returns:

structural object class

setStructuralClass

public void setStructuralClass(java.lang.String s)

Sets the structural object class.

Parameters:

s - structural object class

getRequiredAttributes

public java.lang.String[] getRequiredAttributes()

Returns the required attributes.

Returns:

required attributes

setRequiredAttributes

public void setRequiredAttributes(java.lang.String[] s)

Sets the required attributes.

Parameters:

s - required attributes

getOptionalAttributes

public java.lang.String[] getOptionalAttributes()

Returns the optional attributes.

Returns:

optional attributes

setOptionalAttributes

public void setOptionalAttributes(java.lang.String[] s)

Sets the optional attributes.

Parameters:

s - optional attributes

parse

public static NameForm parse(java.lang.String definition)
                      throws java.text.ParseException

Parses the supplied definition string and creates an initialized name form.

Parameters:

definition - to parse

Returns:

name form

Throws:

java.text.ParseException - if the supplied definition is invalid

format

public java.lang.String format()

Description copied from interface: SchemaElement

Returns this schema element as formatted string per RFC 4512.

Returns:

formatted string

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractSchemaElement

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object