public final class NameForm extends Object
Modifier and Type | Class and Description |
---|---|
static class |
NameForm.Builder
A fluent API for incrementally constructing name forms.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o)
Returns
true if the provided object is a name form having the
same numeric OID as this name form. |
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 numeric OID of this name form.
|
List<String> |
getNames()
Returns an unmodifiable list containing the user-friendly names that may
be used to reference this name form.
|
String |
getOid()
Returns the numeric OID of this name form.
|
Set<AttributeType> |
getOptionalAttributes()
Returns an unmodifiable set containing the optional attributes of this
name form.
|
Set<AttributeType> |
getRequiredAttributes()
Returns an unmodifiable set containing the required attributes of this
name form.
|
ObjectClass |
getStructuralClass()
Returns the structural objectclass of this name form.
|
int |
hashCode()
Returns the hash code for this name form.
|
boolean |
hasName(String name)
Returns
true if this name form has the specified user-friendly
name. |
boolean |
hasNameOrOid(String nameOrOid)
Returns
true if this name form has the specified user-friendly
name or numeric OID. |
boolean |
isObsolete()
Returns
true if this name form is "obsolete". |
boolean |
isOptional(AttributeType attributeType)
Returns
true if the provided attribute type is included in the
list of optional attributes for this name form. |
boolean |
isRequired(AttributeType attributeType)
Returns
true if the provided attribute type is included in the
list of required attributes for this name form. |
boolean |
isRequiredOrOptional(AttributeType attributeType)
Returns
true if the provided attribute type is included in the
list of optional or required attributes for this name form. |
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 name form having the
same numeric OID as this name form.o
- The object to be compared.true
if the provided object is a name form having the
same numeric OID as this name form.public String getNameOrOid()
public List<String> getNames()
public String getOid()
public Set<AttributeType> getOptionalAttributes()
public Set<AttributeType> getRequiredAttributes()
public ObjectClass getStructuralClass()
public int hashCode()
public boolean hasName(String name)
true
if this name form has the specified user-friendly
name.name
- The name.true
if this name form has the specified user-friendly
name.public boolean hasNameOrOid(String nameOrOid)
true
if this name form has the specified user-friendly
name or numeric OID.nameOrOid
- The name or numeric OID.true
if this name form has the specified user-friendly
name or numeric OID.public boolean isObsolete()
true
if this name form is "obsolete".true
if this name form is "obsolete".public boolean isOptional(AttributeType attributeType)
true
if the provided attribute type is included in the
list of optional attributes for this name form.attributeType
- The attribute type.true
if the provided attribute type is included in the
list of optional attributes for this name form.public boolean isRequired(AttributeType attributeType)
true
if the provided attribute type is included in the
list of required attributes for this name form.attributeType
- The attribute type.true
if the provided attribute type is included in the
list of required attributes for this name form.public boolean isRequiredOrOptional(AttributeType attributeType)
true
if the provided attribute type is included in the
list of optional or required attributes for this name form.attributeType
- The attribute type.true
if the provided attribute type is included in the
list of optional or required attributes for this name form.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.