com.bericotech.clavin.gazetteer.query

Enum AncestryMode

java.lang.Object

java.lang.Enum<AncestryMode>

com.bericotech.clavin.gazetteer.query.AncestryMode

All Implemented Interfaces:

Serializable, Comparable<AncestryMode>

public enum AncestryMode
extends Enum<AncestryMode>

Controls the resolution of the hierarchy of political divisions containing a ResolvedLocation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LAZY Resolve the hierarchy when the parent of a location is requested.
MANUAL Do not resolve hierarchy unless manually requested.
ON_CREATE Resolve the hierarchy when locations are created.

Method Summary

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

ON_CREATE

public static final AncestryMode ON_CREATE

Resolve the hierarchy when locations are created.

LAZY

public static final AncestryMode LAZY

Resolve the hierarchy when the parent of a location is requested. Lazily loaded hierarchies may also be manually loaded to improve performance by loading the hierarchy for multiple locations at once.

MANUAL

public static final AncestryMode MANUAL

Do not resolve hierarchy unless manually requested.

Method Detail

values

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

Returns:

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

valueOf

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