Package org.ldaptive.schema
Class ObjectClass
- java.lang.Object
-
- org.ldaptive.schema.AbstractSchemaElement
-
- org.ldaptive.schema.AbstractNamedSchemaElement
-
- org.ldaptive.schema.ObjectClass
-
- All Implemented Interfaces:
SchemaElement
public class ObjectClass extends AbstractNamedSchemaElement
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
- Author:
- Middleware Services
-
-
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.RegexDefinitionFunction
Parses an object class definition using a regular expression.
-
Constructor Summary
Constructors Constructor Description ObjectClass(java.lang.String s)
Creates a new object class.ObjectClass(java.lang.String oid, java.lang.String[] names, java.lang.String description, boolean obsolete, java.lang.String[] superiorClasses, ObjectClassType objectClassType, java.lang.String[] requiredAttributes, java.lang.String[] optionalAttributes, Extensions extensions)
Creates a new object class.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object o)
java.lang.String
format()
Returns this schema element as formatted string per RFC 4512.ObjectClassType
getObjectClassType()
Returns the object class type.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[]
getSuperiorClasses()
Returns the superior classes.int
hashCode()
static ObjectClass
parse(java.lang.String definition)
Parses the supplied definition string and creates an initialized object class.void
setObjectClassType(ObjectClassType type)
Sets the object class type.void
setOptionalAttributes(java.lang.String[] s)
Sets the optional attributes.void
setRequiredAttributes(java.lang.String[] s)
Sets the required attributes.void
setSuperiorClasses(java.lang.String[] s)
Sets the superior classes.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, getDescription, getExtensions, setDescription, setExtensions
-
-
-
-
Constructor Detail
-
ObjectClass
public ObjectClass(java.lang.String s)
Creates a new object class.- Parameters:
s
- oid
-
ObjectClass
public ObjectClass(java.lang.String oid, java.lang.String[] names, java.lang.String description, boolean obsolete, java.lang.String[] superiorClasses, ObjectClassType objectClassType, java.lang.String[] requiredAttributes, java.lang.String[] optionalAttributes, Extensions extensions)
Creates a new object class.- Parameters:
oid
- oidnames
- namesdescription
- descriptionobsolete
- obsoletesuperiorClasses
- superior classesobjectClassType
- object class typerequiredAttributes
- required attributesoptionalAttributes
- optional attributesextensions
- extensions
-
-
Method Detail
-
getOID
public java.lang.String getOID()
Returns the oid.- Returns:
- oid
-
getSuperiorClasses
public java.lang.String[] getSuperiorClasses()
Returns the superior classes.- Returns:
- superior classes
-
setSuperiorClasses
public void setSuperiorClasses(java.lang.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 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 ObjectClass parse(java.lang.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 java.lang.String format()
Description copied from interface:SchemaElement
Returns this schema element as formatted string per RFC 4512.- Returns:
- formatted string
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classAbstractSchemaElement
-
hashCode
public int hashCode()
- Specified by:
hashCode
in classAbstractSchemaElement
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-