org.apache.directory.shared.ldap.schema
Class MatchingRuleEnum

java.lang.Object
  org.apache.directory.shared.ldap.util.Enum
      org.apache.directory.shared.ldap.util.ValuedEnum
          org.apache.directory.shared.ldap.schema.MatchingRuleEnum

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

public class MatchingRuleEnum

extends ValuedEnum

Type safe enum for a matching rule's comparator and normalizer component usage string. This can be take one of the following three values:

• ORDERING
• EQUALITY
• SUBSTRING

Version:

$Rev: 379008 $

Author:

Apache Directory Project

See Also:

Serialized Form

Field Summary

static MatchingRuleEnum	EQUALITY enum for equality comparator usage
static int	EQUALITY_VAL value for equality usage
static MatchingRuleEnum	ORDERING enum for ordering comparator usage
static int	ORDERING_VAL value for ordering usage
static MatchingRuleEnum	SUBSTRING enum for substring comparator usage
static int	SUBSTRING_VAL value for substring usage

Fields inherited from class org.apache.directory.shared.ldap.util.Enum

iToString

Method Summary

static MatchingRuleEnum	getUsage(java.lang.String usage) Gets the enumeration type for the usage string regardless of case.
static java.util.List	list() Gets a List of the enumerations for matching rule usage.
static java.util.Map	map() Gets the Map of MatchingRuleEnum objects by name using the MatchingRuleEnum class.

Methods inherited from class org.apache.directory.shared.ldap.util.ValuedEnum

compareTo, getEnum, getValue, toString

Methods inherited from class org.apache.directory.shared.ldap.util.Enum

equals, getEnum, getEnumClass, getEnumList, getEnumMap, getName, hashCode, iterator, readResolve

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ORDERING_VAL

public static final int ORDERING_VAL

value for ordering usage

See Also:

Constant Field Values

EQUALITY_VAL

public static final int EQUALITY_VAL

value for equality usage

See Also:

Constant Field Values

SUBSTRING_VAL

public static final int SUBSTRING_VAL

value for substring usage

See Also:

Constant Field Values

ORDERING

public static final MatchingRuleEnum ORDERING

enum for ordering comparator usage

EQUALITY

public static final MatchingRuleEnum EQUALITY

enum for equality comparator usage

SUBSTRING

public static final MatchingRuleEnum SUBSTRING

enum for substring comparator usage

Method Detail

getUsage

public static MatchingRuleEnum getUsage(java.lang.String usage)

Gets the enumeration type for the usage string regardless of case.

Parameters:

usage - the usage string

Returns:

the usage enumeration type

list

public static java.util.List list()

Gets a List of the enumerations for matching rule usage.

Returns:

the List of enumerations possible for matching rule usage

map

public static java.util.Map map()

Gets the Map of MatchingRuleEnum objects by name using the MatchingRuleEnum class.

Returns:

the Map by name of MatchingRuleEnums