org.gedcomx.search

Enum ResultConfidence

java.lang.Object

java.lang.Enum<ResultConfidence>

org.gedcomx.search.ResultConfidence

All Implemented Interfaces:

Serializable, Comparable<ResultConfidence>

public enum ResultConfidence
extends Enum<ResultConfidence>

The levels of confidence of a search result.

Author:

Ryan Heaton

Enum Constant Summary

Enum Constants

Enum Constant and Description
five Result confidence level 5 (highest).
four Result confidence level 4.
one Result confidence level 1 (lowest).
three Result confidence level 3.
two Result confidence level 2.

Method Summary

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

one

public static final ResultConfidence one

Result confidence level 1 (lowest).

two

public static final ResultConfidence two

Result confidence level 2.

three

public static final ResultConfidence three

Result confidence level 3.

four

public static final ResultConfidence four

Result confidence level 4.

five

public static final ResultConfidence five

Result confidence level 5 (highest).

Method Detail

values

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

Returns:

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

valueOf

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

value

public Integer value()