@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public final class NameForm extends Object implements SchemaFileElement
Constructor and Description |
---|
NameForm(String definition,
Map<String,String> names,
String oid,
String description,
boolean isObsolete,
ObjectClass structuralClass,
Set<AttributeType> requiredAttributes,
Set<AttributeType> optionalAttributes,
Map<String,List<String>> extraProperties)
Creates a new name form definition with the provided information.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o)
Indicates whether the provided object is equal to this name form.
|
String |
getDescription()
Retrieves the description for this name form.
|
Map<String,List<String>> |
getExtraProperties()
Retrieves a mapping between the names of any extra non-standard
properties that may be associated with this name form and the
value for that property.
|
String |
getNameOrOID()
Retrieves the name or OID that should be used to reference this
name form.
|
Map<String,String> |
getNames()
Retrieves the set of names that may be used to reference this
name form.
|
String |
getOID()
Retrieves the OID for this name form.
|
Set<AttributeType> |
getOptionalAttributes()
Retrieves the set of optional attributes for this name form.
|
Set<AttributeType> |
getRequiredAttributes()
Retrieves the set of required attributes for this name form.
|
ObjectClass |
getStructuralClass()
Retrieves the reference to the structural objectclass for this
name form.
|
int |
hashCode()
Retrieves the hash code for this name form.
|
boolean |
hasName(String lowerName)
Indicates whether the provided lowercase name may be used to
reference this name form.
|
boolean |
hasNameOrOID(String lowerValue)
Indicates whether the provided lowercase value is equal to the
OID or any of the names that may be used to reference this name
form.
|
boolean |
isObsolete()
Indicates whether this name form is declared "obsolete".
|
boolean |
isOptional(AttributeType attributeType)
Indicates whether the provided attribute type is included in the
optional attribute list for this name form.
|
boolean |
isRequired(AttributeType attributeType)
Indicates whether the provided attribute type is included in the
required attribute list for this name form.
|
boolean |
isRequiredOrOptional(AttributeType attributeType)
Indicates whether the provided attribute type is in the list of
required or optional attributes for this name form.
|
String |
toString()
Retrieves the string representation of this name form in the form
specified in RFC 2252.
|
public NameForm(String definition, Map<String,String> names, String oid, String description, boolean isObsolete, ObjectClass structuralClass, Set<AttributeType> requiredAttributes, Set<AttributeType> optionalAttributes, Map<String,List<String>> extraProperties)
definition
- The definition string used to create
this name form. It must not be
null
.names
- The set of names that may be used to
reference this name form.oid
- The OID for this name form. It must
not be null
.description
- The description for this name form.isObsolete
- Indicates whether this name form is
declared "obsolete".structuralClass
- The structural objectclass with which
this name form is associated. It
must not be null
.requiredAttributes
- The set of required attribute types
for this name form.optionalAttributes
- The set of optional attribute types
for this name form.extraProperties
- A set of extra properties for this
name form.public Map<String,String> getNames()
public boolean hasName(String lowerName)
lowerName
- The name for which to make the determination,
in all lowercase characters.true
if the provided lowercase name may be used
to reference this name form, or false
if not.public String getOID()
public String getNameOrOID()
public boolean hasNameOrOID(String lowerValue)
lowerValue
- The value, in all lowercase characters, that
may be used to make the determination.true
if the provided lowercase value is one of
the names or the OID of this name form, or false
if it is not.public String getDescription()
true
if
there is none.public ObjectClass getStructuralClass()
public Set<AttributeType> getRequiredAttributes()
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 name form, or false
if not.public Set<AttributeType> getOptionalAttributes()
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 name form, 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 optional for this name form, or false
if it
is not.public boolean isObsolete()
true
if this name form is declared
"obsolete", or false
if it is not.public Map<String,List<String>> getExtraProperties()
getExtraProperties
in interface SchemaFileElement
public boolean equals(Object o)
public int hashCode()
Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.