|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.NameForm
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public final class NameForm
This class defines a data structure for storing and interacting with a name form, which defines the attribute type(s) that must and/or may be used in the RDN of an entry with a given structural objectclass.
Constructor Summary | |
---|---|
NameForm(java.lang.String definition,
java.util.Map<java.lang.String,java.lang.String> names,
java.lang.String oid,
java.lang.String description,
boolean isObsolete,
ObjectClass structuralClass,
java.util.Set<AttributeType> requiredAttributes,
java.util.Set<AttributeType> optionalAttributes,
java.util.Map<java.lang.String,java.util.List<java.lang.String>> extraProperties)
Creates a new name form definition with the provided information. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
Indicates whether the provided object is equal to this name form. |
java.lang.String |
getDefinition()
Retrieves the definition string used to create this name form. |
java.lang.String |
getDescription()
Retrieves the description for this name form. |
java.util.Map<java.lang.String,java.util.List<java.lang.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. |
java.util.List<java.lang.String> |
getExtraProperty(java.lang.String propertyName)
Retrieves the value of the specified "extra" property for this name form. |
java.lang.String |
getNameOrOID()
Retrieves the name or OID that should be used to reference this name form. |
java.util.Map<java.lang.String,java.lang.String> |
getNames()
Retrieves the set of names that may be used to reference this name form. |
java.lang.String |
getOID()
Retrieves the OID for this name form. |
java.util.Set<AttributeType> |
getOptionalAttributes()
Retrieves the set of optional attributes for this name form. |
java.util.Set<AttributeType> |
getRequiredAttributes()
Retrieves the set of required attributes for this name form. |
java.lang.String |
getSchemaFile()
Retrieves the path to the schema file that contains the definition 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(java.lang.String lowerName)
Indicates whether the provided lowercase name may be used to reference this name form. |
boolean |
hasNameOrOID(java.lang.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. |
NameForm |
recreateFromDefinition()
Creates a new instance of this name form based on the definition string. |
void |
setExtraProperty(java.lang.String name,
java.util.List<java.lang.String> values)
Specifies the provided "extra" property for this name form. |
void |
setExtraProperty(java.lang.String name,
java.lang.String value)
Specifies the provided "extra" property for this name form. |
void |
setSchemaFile(java.lang.String schemaFile)
Specifies the path to the schema file that contains the definition for this name form. |
java.lang.String |
toString()
Retrieves the string representation of this name form in the form specified in RFC 2252. |
void |
toString(java.lang.StringBuilder buffer,
boolean includeFileElement)
Appends a string representation of this name form in the form specified in RFC 2252 to the provided buffer. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public NameForm(java.lang.String definition, java.util.Map<java.lang.String,java.lang.String> names, java.lang.String oid, java.lang.String description, boolean isObsolete, ObjectClass structuralClass, java.util.Set<AttributeType> requiredAttributes, java.util.Set<AttributeType> optionalAttributes, java.util.Map<java.lang.String,java.util.List<java.lang.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.Method Detail |
---|
public java.lang.String getDefinition()
getDefinition
in interface SchemaFileElement
public NameForm recreateFromDefinition() throws DirectoryException
recreateFromDefinition
in interface SchemaFileElement
DirectoryException
- If a problem occurs while attempting
to create a new name form instance
from the definition string.public java.util.Map<java.lang.String,java.lang.String> getNames()
public boolean hasName(java.lang.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 java.lang.String getOID()
public java.lang.String getNameOrOID()
public boolean hasNameOrOID(java.lang.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 java.lang.String getSchemaFile()
getSchemaFile
in interface SchemaFileElement
null
if it is not known
or if it is not stored in any schema file.public void setSchemaFile(java.lang.String schemaFile)
setSchemaFile
in interface SchemaFileElement
schemaFile
- The path to the schema file that contains the
definition for this name form.public java.lang.String getDescription()
true
if
there is none.public ObjectClass getStructuralClass()
public java.util.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 java.util.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 java.util.Map<java.lang.String,java.util.List<java.lang.String>> getExtraProperties()
public java.util.List<java.lang.String> getExtraProperty(java.lang.String propertyName)
propertyName
- The name of the "extra" property for which
to retrieve the value.
null
if no such property is
defined.public void setExtraProperty(java.lang.String name, java.lang.String value)
name
- The name for the "extra" property. It must not be
null
.value
- The value for the "extra" property, or
null
if the property is to be removed.public void setExtraProperty(java.lang.String name, java.util.List<java.lang.String> values)
name
- The name for the "extra" property. It must not
be null
.values
- The set of value for the "extra" property, or
null
if the property is to be removed.public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- The object for which to make the determination.
true
if the provided object is equal to this
name form, or true
if not.public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer, boolean includeFileElement)
buffer
- The buffer to which the information
should be appended.includeFileElement
- Indicates whether to include an
"extra" property that specifies the
path to the schema file from which
this name form was loaded.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |