public final class ObjectClass extends Object
Where ordered sets of names, attribute types, or extra properties are
provided, the ordering will be preserved when the associated fields are
accessed via their getters or via the toString()
methods.
Modifier and Type | Class and Description |
---|---|
static class |
ObjectClass.Builder
A fluent API for incrementally constructing object classes.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o)
Returns
true if the provided object is an object class having the
same numeric OID as this object class. |
Set<AttributeType> |
getDeclaredOptionalAttributes()
Returns an unmodifiable set containing the optional attributes for this
object class.
|
Set<AttributeType> |
getDeclaredRequiredAttributes()
Returns an unmodifiable set containing the required attributes for this
object class.
|
String |
getDescription()
Returns the description of this schema element, or the empty string if it does not have a description.
|
Map<String,List<String>> |
getExtraProperties()
Returns an unmodifiable map containing all of the extra properties associated with this schema element.
|
String |
getNameOrOid()
Returns the name or OID for this schema definition.
|
List<String> |
getNames()
Returns an unmodifiable list containing the user-defined names that may
be used to reference this schema definition.
|
ObjectClassType |
getObjectClassType()
Returns the objectclass type for this objectclass.
|
String |
getOid()
Returns the OID for this schema definition.
|
Set<AttributeType> |
getOptionalAttributes()
Returns an unmodifiable set containing the optional attributes for this
object class and any superior object classes that it might have.
|
Set<AttributeType> |
getRequiredAttributes()
Returns an unmodifiable set containing the required attributes for this
object class and any superior object classes that it might have.
|
Set<ObjectClass> |
getSuperiorClasses()
Returns an unmodifiable set containing the superior classes for this
object class.
|
int |
hashCode()
Returns the hash code for this object class.
|
boolean |
hasName(String name)
Indicates whether this schema definition has the specified name.
|
boolean |
hasNameOrOid(String value)
Indicates whether this schema definition has the specified name or OID.
|
boolean |
isDescendantOf(ObjectClass objectClass)
Indicates whether this objectclass is a descendant of the provided class.
|
boolean |
isExtensible()
Indicates whether this object class is extensibleObject class.
|
boolean |
isObsolete()
Indicates whether this schema definition is declared "obsolete".
|
boolean |
isOptional(AttributeType attributeType)
Indicates whether the provided attribute type is included in the optional
attribute list for this or any of its superior objectclasses.
|
boolean |
isPlaceHolder()
Returns whether this object class is a placeholder,
i.e.
|
boolean |
isRequired(AttributeType attributeType)
Indicates whether the provided attribute type is included in the required
attribute list for this or any of its superior objectclasses.
|
boolean |
isRequiredOrOptional(AttributeType attributeType)
Indicates whether the provided attribute type is in the list of required
or optional attributes for this objectclass or any of its superior classes.
|
String |
toString()
Returns the string representation of this schema element as defined in
RFC 2252.
|
public boolean equals(Object o)
true
if the provided object is an object class having the
same numeric OID as this object class.o
- The object to be compared.true
if the provided object is a object class having the
same numeric OID as this object class.public Set<AttributeType> getDeclaredOptionalAttributes()
public Set<AttributeType> getDeclaredRequiredAttributes()
public String getNameOrOid()
public List<String> getNames()
public ObjectClassType getObjectClassType()
public String getOid()
public Set<AttributeType> getOptionalAttributes()
public Set<AttributeType> getRequiredAttributes()
public Set<ObjectClass> getSuperiorClasses()
public int hashCode()
public boolean hasName(String name)
name
- The name for which to make the determination.true
if the specified name is assigned to this
schema definition, or false
if not.public boolean hasNameOrOid(String value)
value
- The value for which to make the determination.true
if the provided value matches the OID or one of
the names assigned to this schema definition, or
false
if not.public boolean isDescendantOf(ObjectClass objectClass)
objectClass
- The objectClass for which to make the determination.true
if this objectclass is a descendant of the
provided class, or false
if not.public boolean isExtensible()
An extensible object class has an optional attributes list corresponding to all the attributes types defined in the schema. It means any attribute type can be used with this object class.
true
if this object class is extensible.public boolean isObsolete()
true
if this schema definition is declared "obsolete", or false
if not.public boolean isPlaceHolder()
true
if this object class is a placeholder,
false
otherwisepublic boolean isOptional(AttributeType attributeType)
attributeType
- The attribute type for which to make the determination.true
if the provided attribute type is optional for
this objectclass or any of its superior classes,
or false
if not.public boolean isRequired(AttributeType attributeType)
attributeType
- The attribute type for which to make the determination.true
if the provided attribute type is required by
this objectclass or any of its superior classes,
or false
if not.public boolean isRequiredOrOptional(AttributeType attributeType)
attributeType
- The attribute type for which to make the determination.true
if the provided attribute type is required or
allowed for this objectclass or any of its superior classes, or
false
if it is not.public final String getDescription()
SchemaElement
getDescription
in interface SchemaElement
public final Map<String,List<String>> getExtraProperties()
SchemaElement
getExtraProperties
in interface SchemaElement
Copyright 2010-2022 ForgeRock AS.