Package org.forgerock.opendj.ldap.schema

Enum Class MatchingRule.MatchingRuleType

java.lang.Object

java.lang.Enum<MatchingRule.MatchingRuleType>

org.forgerock.opendj.ldap.schema.MatchingRule.MatchingRuleType

All Implemented Interfaces:

Serializable, Comparable<MatchingRule.MatchingRuleType>, java.lang.constant.Constable

Enclosing class:

MatchingRule

public static enum MatchingRule.MatchingRuleType
extends Enum<MatchingRule.MatchingRuleType>

Represents the types of matching rules, according to RFC 4517 section 4.1.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EQUALITY	A rule suitable for use as the equality matching rule (EQUALITY) of an attribute type.
ORDERING	A rule suitable for use as the ordering matching rule (ORDERING) of an attribute type.
SUBSTRING	A rule suitable for use as the substrings matching rule (SUBSTR) of an attribute type.

Method Summary

Modifier and Type	Method	Description
static MatchingRule.MatchingRuleType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MatchingRule.MatchingRuleType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EQUALITY

public static final MatchingRule.MatchingRuleType EQUALITY

A rule suitable for use as the equality matching rule (EQUALITY) of an attribute type. Note that we consider approximate matching rules to be EQUALITY matching rules: although they implement a "fuzzy" type of equality, they are trying to decide if two values are equal.

ORDERING

public static final MatchingRule.MatchingRuleType ORDERING

A rule suitable for use as the ordering matching rule (ORDERING) of an attribute type.

SUBSTRING

public static final MatchingRule.MatchingRuleType SUBSTRING

A rule suitable for use as the substrings matching rule (SUBSTR) of an attribute type.

Method Details

values

public static MatchingRule.MatchingRuleType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MatchingRule.MatchingRuleType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null