public final class DitContentRule extends Object
Modifier and Type | Class and Description |
---|---|
static class |
DitContentRule.Builder
A fluent API for incrementally constructing DIT content rule.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o)
Returns
true if the provided object is a DIT content rule having
the same structural object class OID as this DIT content rule. |
Set<ObjectClass> |
getAuxiliaryClasses()
Returns an unmodifiable set containing the auxiliary objectclasses that
may be used for entries associated with this DIT content rule.
|
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 structural class 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.
|
Set<AttributeType> |
getOptionalAttributes()
Returns an unmodifiable set containing the optional attributes for this
DIT content rule.
|
Set<AttributeType> |
getProhibitedAttributes()
Returns an unmodifiable set containing the prohibited attributes for this
DIT content rule.
|
Set<AttributeType> |
getRequiredAttributes()
Returns an unmodifiable set containing the required attributes for this
DIT content rule.
|
ObjectClass |
getStructuralClass()
Returns the structural objectclass for this DIT content rule.
|
String |
getStructuralClassOid()
Returns the structural class OID for this schema definition.
|
int |
hashCode()
Returns the hash code for this DIT content rule.
|
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
structural class OID.
|
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 DIT content rule.
|
boolean |
isRequired(AttributeType attributeType)
Indicates whether the provided attribute type is included in the required
attribute list for this DIT content rule.
|
boolean |
isRequiredOrOptional(AttributeType attributeType)
Indicates whether the provided attribute type is in the list of required
or optional attributes for this DIT content rule.
|
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 a DIT content rule having
the same structural object class OID as this DIT content rule.o
- The object to be compared.true
if the provided object is a DIT content rule having
the same numeric OID as this DIT content rule.public Set<ObjectClass> getAuxiliaryClasses()
public String getNameOrOid()
public List<String> getNames()
public Set<AttributeType> getOptionalAttributes()
public Set<AttributeType> getProhibitedAttributes()
public Set<AttributeType> getRequiredAttributes()
public ObjectClass getStructuralClass()
public String getStructuralClassOid()
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 isObsolete()
true
if this schema definition is declared
"obsolete", or false
if not.public boolean isOptional(AttributeType attributeType)
attributeType
- The attribute type for which to make the determination.true
if the provided attribute type is optional for
this DIT content rule, 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 DIT content rule, 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 DIT content rule, 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.