Package org.apache.directory.api.ldap.model.schema

Enum MatchingRuleTypeEnum

java.lang.Object

java.lang.Enum<MatchingRuleTypeEnum>

org.apache.directory.api.ldap.model.schema.MatchingRuleTypeEnum

All Implemented Interfaces:

Serializable, Comparable<MatchingRuleTypeEnum>

public enum MatchingRuleTypeEnum
extends Enum<MatchingRuleTypeEnum>

This Enum is used to list the MatchingRules that will be subject to a PrepareString.

Author:

Apache Directory Project

Enum Constant Summary

Enum Constants

Enum Constant	Description
CASE_EXACT_IA5_MATCH	Case Exact IA5 Match
CASE_EXACT_MATCH	Case Exact Match
CASE_EXACT_ORDERING_MATCH	Case Exact Ordering Match
CASE_EXACT_SUBSTRINGS_MATCH	Case Exact Substring Match
CASE_IGNORE_IA5_MATCH	Case Ignore Match
CASE_IGNORE_IA5_SUBSTRINGS_MATCH	Case Ignore IA5 Substring Match
CASE_IGNORE_LIST_MATCH	Case Ignore List Match
CASE_IGNORE_LIST_SUBSTRINGS_MATCH	Case Ignore List Substring Match
CASE_IGNORE_MATCH	Case Ignore Match
CASE_IGNORE_ORDERING_MATCH	Case Ignore Ordering Match
CASE_IGNORE_SUBSTRINGS_MATCH	CaseIgnore Substring Match
DIRECTORY_STRING_FIRST_COMPONENT_MATCH	DirectoryString First Component Match
NUMERIC_STRING_MATCH	Numeric String Match
NUMERIC_STRING_ORDERING_MATCH	Numeric String Ordering Match
NUMERIC_STRING_SUBSTRINGS_MATCH	Numeric String Substring Match
TELEPHONE_NUMBER_MATCH	Telephone Number Match
TELEPHONE_NUMBER_SUBSTRINGS_MATCH	Telephone Number Substring Match
WORD_MATCH	Word Match

Method Summary

Modifier and Type	Method	Description
static MatchingRuleTypeEnum	getMatchingRuleType(String oid)	Get the MatchingRuleTypeEnum associated with an OID
static MatchingRuleTypeEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MatchingRuleTypeEnum[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CASE_EXACT_MATCH

public static final MatchingRuleTypeEnum CASE_EXACT_MATCH

Case Exact Match

CASE_EXACT_IA5_MATCH

public static final MatchingRuleTypeEnum CASE_EXACT_IA5_MATCH

Case Exact IA5 Match

CASE_IGNORE_IA5_MATCH

public static final MatchingRuleTypeEnum CASE_IGNORE_IA5_MATCH

Case Ignore Match

CASE_IGNORE_LIST_MATCH

public static final MatchingRuleTypeEnum CASE_IGNORE_LIST_MATCH

Case Ignore List Match

CASE_IGNORE_MATCH

public static final MatchingRuleTypeEnum CASE_IGNORE_MATCH

Case Ignore Match

DIRECTORY_STRING_FIRST_COMPONENT_MATCH

public static final MatchingRuleTypeEnum DIRECTORY_STRING_FIRST_COMPONENT_MATCH

DirectoryString First Component Match

NUMERIC_STRING_MATCH

public static final MatchingRuleTypeEnum NUMERIC_STRING_MATCH

Numeric String Match

TELEPHONE_NUMBER_MATCH

public static final MatchingRuleTypeEnum TELEPHONE_NUMBER_MATCH

Telephone Number Match

WORD_MATCH

public static final MatchingRuleTypeEnum WORD_MATCH

Word Match

CASE_EXACT_ORDERING_MATCH

public static final MatchingRuleTypeEnum CASE_EXACT_ORDERING_MATCH

Case Exact Ordering Match

CASE_IGNORE_ORDERING_MATCH

public static final MatchingRuleTypeEnum CASE_IGNORE_ORDERING_MATCH

Case Ignore Ordering Match

NUMERIC_STRING_ORDERING_MATCH

public static final MatchingRuleTypeEnum NUMERIC_STRING_ORDERING_MATCH

Numeric String Ordering Match

CASE_EXACT_SUBSTRINGS_MATCH

public static final MatchingRuleTypeEnum CASE_EXACT_SUBSTRINGS_MATCH

Case Exact Substring Match

CASE_IGNORE_IA5_SUBSTRINGS_MATCH

public static final MatchingRuleTypeEnum CASE_IGNORE_IA5_SUBSTRINGS_MATCH

Case Ignore IA5 Substring Match

CASE_IGNORE_LIST_SUBSTRINGS_MATCH

public static final MatchingRuleTypeEnum CASE_IGNORE_LIST_SUBSTRINGS_MATCH

Case Ignore List Substring Match

CASE_IGNORE_SUBSTRINGS_MATCH

public static final MatchingRuleTypeEnum CASE_IGNORE_SUBSTRINGS_MATCH

CaseIgnore Substring Match

NUMERIC_STRING_SUBSTRINGS_MATCH

public static final MatchingRuleTypeEnum NUMERIC_STRING_SUBSTRINGS_MATCH

Numeric String Substring Match

TELEPHONE_NUMBER_SUBSTRINGS_MATCH

public static final MatchingRuleTypeEnum TELEPHONE_NUMBER_SUBSTRINGS_MATCH

Telephone Number Substring Match

Method Detail

values

public static MatchingRuleTypeEnum[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MatchingRuleTypeEnum c : MatchingRuleTypeEnum.values())
    System.out.println(c);

Returns:

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

valueOf

public static MatchingRuleTypeEnum valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getMatchingRuleType

public static MatchingRuleTypeEnum getMatchingRuleType(String oid)

Get the MatchingRuleTypeEnum associated with an OID

Parameters:

oid - The OID for which we want the MatchingRuleTypeEnum.

Returns:

The MatchingRuleTypeEnum we found, or null.