com.bigdata.btree.keys

Enum StrengthEnum

java.lang.Object

java.lang.Enum<StrengthEnum>

com.bigdata.btree.keys.StrengthEnum

All Implemented Interfaces:

Serializable, Comparable<StrengthEnum>

public enum StrengthEnum
extends Enum<StrengthEnum>

Type safe enumeration for the strength.

Note: ICU and the JDK use different integer constants for the #IDENTICAL strength

Version:

$Id$

Author:

Bryan Thompson

Enum Constant Summary

Enum Constants

Enum Constant and Description
Identical See Collator.IDENTICAL.
Primary See Collator.PRIMARY.
Quaternary Note: this option is NOT supported by the JDK.
Secondary See Collator.SECONDARY.
Tertiary See Collator.TERTIARY.

Method Summary

Methods

Modifier and Type	Method and Description
static StrengthEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static StrengthEnum[]	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

Primary

public static final StrengthEnum Primary

See Collator.PRIMARY.

Secondary

public static final StrengthEnum Secondary

See Collator.SECONDARY.

Tertiary

public static final StrengthEnum Tertiary

See Collator.TERTIARY.

Quaternary

public static final StrengthEnum Quaternary

Note: this option is NOT supported by the JDK.

Identical

public static final StrengthEnum Identical

See Collator.IDENTICAL.

Method Detail

values

public static StrengthEnum[] 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 (StrengthEnum c : StrengthEnum.values())
    System.out.println(c);

Returns:

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

valueOf

public static StrengthEnum 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