|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.DITStructureRule
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public final class DITStructureRule
This class defines a DIT structure rule, which is used to indicate the types of children that entries may have.
Constructor Summary | |
---|---|
DITStructureRule(java.lang.String definition,
java.util.Map<java.lang.String,java.lang.String> names,
int ruleID,
java.lang.String description,
boolean isObsolete,
NameForm nameForm,
java.util.Set<DITStructureRule> superiorRules,
java.util.Map<java.lang.String,java.util.List<java.lang.String>> extraProperties)
Creates a new DIT structure rule with the provided information. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
Indicates whether the provided object is equal to this DIT structure rule. |
java.lang.String |
getDefinition()
Retrieves the definition string used to create this DIT structure rule. |
java.lang.String |
getDescription()
Retrieves the description for this DIT structure rule. |
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 DIT structure rule 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 DIT structure rule. |
NameForm |
getNameForm()
Retrieves the name form for this DIT structure rule. |
java.lang.String |
getNameOrRuleID()
Retrieves the name or rule ID for this DIT structure rule. |
java.util.Map<java.lang.String,java.lang.String> |
getNames()
Retrieves the set of names that may be used to reference this DIT structure rule. |
int |
getRuleID()
Retrieves the rule ID for this DIT structure rule. |
java.lang.String |
getSchemaFile()
Retrieves the path to the schema file that contains the definition for this DIT structure rule. |
ObjectClass |
getStructuralClass()
Retrieves the structural objectclass for the name form with which this DIT structure rule is associated. |
java.util.Set<DITStructureRule> |
getSuperiorRules()
Retrieves the set of superior rules for this DIT structure rule. |
int |
hashCode()
Retrieves the hash code for this DIT structure rule. |
boolean |
hasName(java.lang.String lowerName)
Indicates whether this DIT structure rule has the specified name. |
boolean |
hasSuperiorRules()
Indicates whether this DIT structure rule has one or more superior rules. |
boolean |
isObsolete()
Indicates whether this DIT structure rule is declared "obsolete". |
DITStructureRule |
recreateFromDefinition()
Creates a new instance of this DIT structure rule 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 DIT structure rule. |
void |
setExtraProperty(java.lang.String name,
java.lang.String value)
Specifies the provided "extra" property for this DIT structure rule. |
void |
setSchemaFile(java.lang.String schemaFile)
Specifies the path to the schema file that contains the definition for this DIT structure rule. |
java.lang.String |
toString()
Retrieves the string representation of this attribute type in the form specified in RFC 2252. |
void |
toString(java.lang.StringBuilder buffer,
boolean includeFileElement)
Appends a string representation of this attribute type 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 DITStructureRule(java.lang.String definition, java.util.Map<java.lang.String,java.lang.String> names, int ruleID, java.lang.String description, boolean isObsolete, NameForm nameForm, java.util.Set<DITStructureRule> superiorRules, java.util.Map<java.lang.String,java.util.List<java.lang.String>> extraProperties)
definition
- The definition string used to create
this DIT structure rule. It must not be
null
.names
- The set of names for this DIT structure
rule, mapping the lowercase names to the
user-defined values.ruleID
- The rule ID for this DIT structure rule.description
- The description for this DIT structure
rule.isObsolete
- Indicates whether this DIT structure
rule is declared "obsolete".nameForm
- The name form for this DIT structure
rule.superiorRules
- References to the superior rules for
this DIT structure rule.extraProperties
- The set of "extra" properties associated
with this DIT structure rules.Method Detail |
---|
public java.lang.String getDefinition()
getDefinition
in interface SchemaFileElement
public DITStructureRule recreateFromDefinition() throws DirectoryException
recreateFromDefinition
in interface SchemaFileElement
DirectoryException
- If a problem occurs while attempting
to create a new DIT structure rule
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 lowercase name for which to make the
determination.
true
if the specified name is assigned to this
DIT structure rule, or false
if not.public int getRuleID()
public java.lang.String getNameOrRuleID()
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 DIT structure rule.public java.lang.String getDescription()
public NameForm getNameForm()
public ObjectClass getStructuralClass()
public java.util.Set<DITStructureRule> getSuperiorRules()
public boolean hasSuperiorRules()
true
if this DIT structure rule has one or more
superior rules, or false
if not.public boolean isObsolete()
true
if this DIT structure rule is declared
"obsolete", or false
if 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
attribute, or false
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 DIT structure rule was loaded.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |