|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.MatchingRuleUse
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public final class MatchingRuleUse
This class defines a data structure for storing and interacting with a matching rule use definition, which may be used to restrict the set of attribute types that may be used for a given matching rule.
Constructor Summary | |
---|---|
MatchingRuleUse(java.lang.String definition,
MatchingRule matchingRule,
java.util.Map<java.lang.String,java.lang.String> names,
java.lang.String description,
boolean isObsolete,
java.util.Set<AttributeType> attributes,
java.util.Map<java.lang.String,java.util.List<java.lang.String>> extraProperties)
Creates a new matching rule use definition with the provided information. |
Method Summary | |
---|---|
boolean |
appliesToAttribute(AttributeType attributeType)
Indicates whether the provided attribute type is referenced by this matching rule use. |
boolean |
equals(java.lang.Object o)
Indicates whether the provided object is equal to this matching rule use. |
java.util.Set<AttributeType> |
getAttributes()
Retrieves the set of attributes associated with this matching rule use. |
java.lang.String |
getDefinition()
Retrieves the definition string used to create this matching rule use. |
java.lang.String |
getDescription()
Retrieves the description for this matching rule use. |
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 matching rule use 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 matching rule use. |
MatchingRule |
getMatchingRule()
Retrieves the matching rule for this matching rule use. |
java.lang.String |
getName()
Retrieves the primary name to use when referencing this matching rule use. |
java.util.Map<java.lang.String,java.lang.String> |
getNames()
Retrieves the set of names for this matching rule use. |
java.lang.String |
getSchemaFile()
Retrieves the path to the schema file that contains the definition for this matching rule use. |
int |
hashCode()
Retrieves the hash code for this matching rule use. |
boolean |
hasName(java.lang.String lowerName)
Indicates whether this matching rule use has the specified name. |
boolean |
isObsolete()
Indicates whether this matching rule use is declared "obsolete". |
MatchingRuleUse |
recreateFromDefinition()
Creates a new instance of this matching rule use 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 matching rule use. |
void |
setExtraProperty(java.lang.String name,
java.lang.String value)
Specifies the provided "extra" property for this matching rule use. |
void |
setSchemaFile(java.lang.String schemaFile)
Specifies the path to the schema file that contains the definition for this matching rule use. |
java.lang.String |
toString()
Retrieves the string representation of this matching rule use in the form specified in RFC 2252. |
void |
toString(java.lang.StringBuilder buffer,
boolean includeFileElement)
Appends a string representation of this matching rule use 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 MatchingRuleUse(java.lang.String definition, MatchingRule matchingRule, java.util.Map<java.lang.String,java.lang.String> names, java.lang.String description, boolean isObsolete, java.util.Set<AttributeType> attributes, java.util.Map<java.lang.String,java.util.List<java.lang.String>> extraProperties)
definition
- The definition string used to create
this matching rule use. It must not be
null
.matchingRule
- The matching rule for this matching rule
use. It must not be null
.names
- The set of names for this matching rule
use.description
- The description for this matching rule
use.isObsolete
- Indicates whether this matching rule use
is declared "obsolete".attributes
- The set of attribute types for this
matching rule use.extraProperties
- A set of "extra" properties that may be
associated with this matching rule use.Method Detail |
---|
public java.lang.String getDefinition()
getDefinition
in interface SchemaFileElement
public MatchingRuleUse recreateFromDefinition() throws DirectoryException
recreateFromDefinition
in interface SchemaFileElement
DirectoryException
- If a problem occurs while attempting
to create a new matching rule use
instance from the definition string.public MatchingRule getMatchingRule()
public java.util.Map<java.lang.String,java.lang.String> getNames()
public java.lang.String getName()
null
if there is none.public boolean hasName(java.lang.String lowerName)
lowerName
- The name for which to make the determination,
formatted in all lowercase characters.
true
if this matching rule use has the specified
name, or false
if 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 matching rule use.public java.lang.String getDescription()
null
if there is none.public boolean isObsolete()
true
if this matching rule use is declared
"obsolete", or false
if it is not.public java.util.Set<AttributeType> getAttributes()
public boolean appliesToAttribute(AttributeType attributeType)
attributeType
- The attribute type for which to make the
determination.
true
if the provided attribute type is
referenced by this matching rule use, 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
matching rule use, 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 matching rule use was loaded.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |