Package org.ldaptive.schema

Class DITContentRule

java.lang.Object

org.ldaptive.AbstractFreezable

org.ldaptive.schema.AbstractSchemaElement<T>

org.ldaptive.schema.AbstractNamedSchemaElement<String>

org.ldaptive.schema.DITContentRule

All Implemented Interfaces:

Freezable, NamedElement, SchemaElement<String>

public final class DITContentRule
extends AbstractNamedSchemaElement<String>

Bean for a DIT content rule schema element.

   DITContentRuleDescription = LPAREN WSP
     numericoid                 ; object identifier
     [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
     [ SP "DESC" SP qdstring ]  ; description
     [ SP "OBSOLETE" ]          ; not active
     [ SP "AUX" SP oids ]       ; auxiliary object classes
     [ SP "MUST" SP oids ]      ; attribute types
     [ SP "MAY" SP oids ]       ; attribute types
     [ SP "NOT" SP oids ]       ; attribute types
     extensions WSP RPAREN      ; extensions
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DITContentRule.DefaultDefinitionFunction	Parses a DIT content rule definition using a char buffer.
static class	DITContentRule.DefaultSchemaElementFormatter	Creates a string representation of a DIT content rule.
static class	DITContentRule.RegexDefinitionFunction	Parses a DIT content rule definition using a regular expression.

Field Summary

Fields

Modifier and Type	Field	Description
private String[]	auxiliaryClasses	Auxiliary classes.
private static final int	HASH_CODE_SEED	hash code seed.
private final String	oid	OID.
private String[]	optionalAttributes	Optional attributes.
private String[]	requiredAttributes	Required attributes.
private String[]	restrictedAttributes	Restricted attributes.

Constructor Summary

Constructors

Constructor	Description
DITContentRule(String s)	Creates a new DIT content rule.
DITContentRule(String oid, String[] names, String description, boolean obsolete, String[] auxiliaryClasses, String[] requiredAttributes, String[] optionalAttributes, String[] restrictedAttributes, Extensions extensions)	Creates a new DIT content rule.

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<DITContentRule> formatter)	Returns a string representation of this element.
String[]	getAuxiliaryClasses()	Returns the auxiliary classes.
String	getElementKey()	Returns the key for this element.
String	getOID()	Returns the oid.
String[]	getOptionalAttributes()	Returns the optional attributes.
String[]	getRequiredAttributes()	Returns the required attributes.
String[]	getRestrictedAttributes()	Returns the restricted attributes.
int	hashCode()
static DITContentRule	parse(String definition)	Parses the supplied definition string and creates an initialized DIT content rule.
void	setAuxiliaryClasses(String... s)	Sets the auxiliary classes.
void	setOptionalAttributes(String... s)	Sets the optional attributes.
void	setRequiredAttributes(String... s)	Sets the required attributes.
void	setRestrictedAttributes(String... s)	Sets the restricted attributes.
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, 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.

auxiliaryClasses

private String[] auxiliaryClasses

Auxiliary classes.

requiredAttributes

private String[] requiredAttributes

Required attributes.

optionalAttributes

private String[] optionalAttributes

Optional attributes.

restrictedAttributes

private String[] restrictedAttributes

Restricted attributes.

Constructor Details

DITContentRule

public DITContentRule(String s)

Creates a new DIT content rule.

Parameters:

s - oid

DITContentRule

public DITContentRule(String oid,
 String[] names,
 String description,
 boolean obsolete,
 String[] auxiliaryClasses,
 String[] requiredAttributes,
 String[] optionalAttributes,
 String[] restrictedAttributes,
 Extensions extensions)

Creates a new DIT content rule.

Parameters:

oid - oid

names - names

description - description

obsolete - obsolete

auxiliaryClasses - auxiliary classes

requiredAttributes - required attributes

optionalAttributes - optional attributes

restrictedAttributes - restricted attributes

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

getAuxiliaryClasses

public String[] getAuxiliaryClasses()

Returns the auxiliary classes.

Returns:

auxiliary classes

setAuxiliaryClasses

public void setAuxiliaryClasses(String... s)

Sets the auxiliary classes.

Parameters:

s - auxiliary classes

getRequiredAttributes

public String[] getRequiredAttributes()

Returns the required attributes.

Returns:

required attributes

setRequiredAttributes

public void setRequiredAttributes(String... s)

Sets the required attributes.

Parameters:

s - required attributes

getOptionalAttributes

public String[] getOptionalAttributes()

Returns the optional attributes.

Returns:

optional attributes

setOptionalAttributes

public void setOptionalAttributes(String... s)

Sets the optional attributes.

Parameters:

s - optional attributes

getRestrictedAttributes

public String[] getRestrictedAttributes()

Returns the restricted attributes.

Returns:

restricted attributes

setRestrictedAttributes

public void setRestrictedAttributes(String... s)

Sets the restricted attributes.

Parameters:

s - restricted attributes

parse

public static DITContentRule parse(String definition)
                            throws SchemaParseException

Parses the supplied definition string and creates an initialized DIT content rule.

Parameters:

definition - to parse

Returns:

DIT content rule

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<DITContentRule> 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