com.unboundid.directory.sdk.common.schema

Interface MatchingRuleUse

@NotExtensible
 @ThreadSafety(level=INTERFACE_THREADSAFE)
public interface MatchingRuleUse

This interface defines a set of methods that may be used to obtain information about a matching rule use defined in the server schema.

Method Summary

Modifier and Type	Method and Description
boolean	appliesToAttribute(AttributeType t) Indicates whether this matching rule use applies to the provided attribute type.
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 that are associated with this matching rule use.
java.lang.String	getDescription() Retrieves the description for this DIT content rule, if any.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getExtensions() Retrieves a map of all defined extensions for this matching rule use.
MatchingRule	getMatchingRule() Retrieves the matching rule for this matching rule use.
java.util.List<java.lang.String>	getNames() Retrieves the list of names for this matching rule use, if any.
java.lang.String	getSchemaFileName() Retrieves the name of the schema file in which this matching rule use is defined.
int	hashCode() Retrieves a hash code for this matching rule use.
boolean	hasName(java.lang.String name) Indicates whether the provided string is equal to any of the defined names for this matching rule use.
boolean	isObsolete() Indicates whether this matching rule use is declared obsolete in the server schema.
java.lang.String	toString() Retrieves a string representation of this matching rule use definition.

Method Detail

getNames

java.util.List<java.lang.String> getNames()

Retrieves the list of names for this matching rule use, if any.

Returns:

The list of names for this matching rule use, or an empty list if there are no user-defined names.

hasName

boolean hasName(java.lang.String name)

Indicates whether the provided string is equal to any of the defined names for this matching rule use.

Parameters:

name - The name for which to make the determination.

Returns:

true if the provided string matches one of the names for this matching rule use, or false if not.

getMatchingRule

MatchingRule getMatchingRule()

Retrieves the matching rule for this matching rule use.

Returns:

The matching rule for this matching rule use.

getDescription

java.lang.String getDescription()

Retrieves the description for this DIT content rule, if any.

Returns:

The description for this DIT content rule, or null if it does not have a description.

getAttributes

java.util.Set<AttributeType> getAttributes()

Retrieves the set of attributes that are associated with this matching rule use.

Returns:

The set of attributes that are associated with this matching rule use.

appliesToAttribute

boolean appliesToAttribute(AttributeType t)

Indicates whether this matching rule use applies to the provided attribute type.

Parameters:

t - The attribute type for which to make the determination.

Returns:

true if this matching rule use applies to the provided attribute type, or false if not.

isObsolete

boolean isObsolete()

Indicates whether this matching rule use is declared obsolete in the server schema.

Returns:

true if this matching rule use is declared obsolete in the server schema, or false if not.

getExtensions

java.util.Map<java.lang.String,java.util.List<java.lang.String>> getExtensions()

Retrieves a map of all defined extensions for this matching rule use.

Returns:

A map of all defined extensions for this matching rule use.

getSchemaFileName

java.lang.String getSchemaFileName()

Retrieves the name of the schema file in which this matching rule use is defined.

Returns:

The name of the schema file in which this matching rule use is defined.

equals

boolean equals(java.lang.Object o)

Indicates whether the provided object is equal to this matching rule use.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object for which to make the determination.

Returns:

true if the provided object is equal to this matching rule use, or false if not.

hashCode

int hashCode()

Retrieves a hash code for this matching rule use.

Overrides:

hashCode in class java.lang.Object

Returns:

A hash code for this matching rule use.

toString

java.lang.String toString()

Retrieves a string representation of this matching rule use definition.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this matching rule use definition.