Package org.ldaptive.schema

Class ObjectClass

java.lang.Object

org.ldaptive.AbstractFreezable

org.ldaptive.schema.AbstractSchemaElement<T>

org.ldaptive.schema.AbstractNamedSchemaElement<String>

org.ldaptive.schema.ObjectClass

All Implemented Interfaces:

Freezable, NamedElement, SchemaElement<String>

public final class ObjectClass
extends AbstractNamedSchemaElement<String>

Bean for an object class schema element.

   ObjectClassDescription = LPAREN WSP
     numericoid                 ; object identifier
     [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
     [ SP "DESC" SP qdstring ]  ; description
     [ SP "OBSOLETE" ]          ; not active
     [ SP "SUP" SP oids ]       ; superior object classes
     [ SP kind ]                ; kind of class
     [ SP "MUST" SP oids ]      ; attribute types
     [ SP "MAY" SP oids ]       ; attribute types
     extensions WSP RPAREN
 

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	HASH_CODE_SEED	hash code seed.
private ObjectClassType	objectClassType	Object class type.
private final String	oid	OID.
private String[]	optionalAttributes	Optional attributes.
private String[]	requiredAttributes	Required attributes.
private String[]	superiorClasses	Superior classes.

Constructor Summary

Constructors

Constructor	Description
ObjectClass(String s)	Creates a new object class.
ObjectClass(String oid, String[] names, String description, boolean obsolete, String[] superiorClasses, ObjectClassType objectClassType, String[] requiredAttributes, String[] optionalAttributes, Extensions extensions)	Creates a new object class.

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<ObjectClass> formatter)	Returns a string representation of this element.
String	getElementKey()	Returns the key for this element.
ObjectClassType	getObjectClassType()	Returns the object class type.
String	getOID()	Returns the oid.
String[]	getOptionalAttributes()	Returns the optional attributes.
String[]	getRequiredAttributes()	Returns the required attributes.
String[]	getSuperiorClasses()	Returns the superior classes.
int	hashCode()
static ObjectClass	parse(String definition)	Parses the supplied definition string and creates an initialized object class.
void	setObjectClassType(ObjectClassType type)	Sets the object class type.
void	setOptionalAttributes(String... s)	Sets the optional attributes.
void	setRequiredAttributes(String... s)	Sets the required attributes.
void	setSuperiorClasses(String... s)	Sets the superior classes.
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.

superiorClasses

private String[] superiorClasses

Superior classes.

objectClassType

private ObjectClassType objectClassType

Object class type.

requiredAttributes

private String[] requiredAttributes

Required attributes.

optionalAttributes

private String[] optionalAttributes

Optional attributes.

Constructor Details

ObjectClass

public ObjectClass(String s)

Creates a new object class.

Parameters:

s - oid

ObjectClass

public ObjectClass(String oid,
 String[] names,
 String description,
 boolean obsolete,
 String[] superiorClasses,
 ObjectClassType objectClassType,
 String[] requiredAttributes,
 String[] optionalAttributes,
 Extensions extensions)

Creates a new object class.

Parameters:

oid - oid

names - names

description - description

obsolete - obsolete

superiorClasses - superior classes

objectClassType - object class type

requiredAttributes - required attributes

optionalAttributes - optional 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

getSuperiorClasses

public String[] getSuperiorClasses()

Returns the superior classes.

Returns:

superior classes

setSuperiorClasses

public void setSuperiorClasses(String... s)

Sets the superior classes.

Parameters:

s - superior classes

getObjectClassType

public ObjectClassType getObjectClassType()

Returns the object class type.

Returns:

object class type

setObjectClassType

public void setObjectClassType(ObjectClassType type)

Sets the object class type.

Parameters:

type - object class type

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

parse

public static ObjectClass parse(String definition)
                         throws SchemaParseException

Parses the supplied definition string and creates an initialized object class.

Parameters:

definition - to parse

Returns:

object class

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