Package gov.usgs.earthquake.indexer

Enum Class SearchMethod

java.lang.Object

java.lang.Enum<SearchMethod>

gov.usgs.earthquake.indexer.SearchMethod

All Implemented Interfaces:

Serializable, Comparable<SearchMethod>, Constable

public enum SearchMethod
extends Enum<SearchMethod>

Different types of searches that are supported.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EVENT_DETAIL	Detail for one event.
EVENTS_SUMMARY	Summary for multiple events.
PRODUCT_DETAIL	Detail for one product.
PRODUCTS_SUMMARY	Summary for multiple products.

Method Summary

Modifier and Type	Method	Description
static SearchMethod	fromXmlMethodName(String xmlMethodName)	Get the enumerated value for the given xml string.
String	getXmlMethodName()
static SearchMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchMethod[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EVENTS_SUMMARY

public static final SearchMethod EVENTS_SUMMARY

Summary for multiple events.

EVENT_DETAIL

public static final SearchMethod EVENT_DETAIL

Detail for one event.

PRODUCTS_SUMMARY

public static final SearchMethod PRODUCTS_SUMMARY

Summary for multiple products.

PRODUCT_DETAIL

public static final SearchMethod PRODUCT_DETAIL

Detail for one product.

Method Details

values

public static SearchMethod[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SearchMethod valueOf(String name)

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

NullPointerException - if the argument is null

getXmlMethodName

public String getXmlMethodName()

Returns:

The XML string used to represent this response type.

fromXmlMethodName

public static SearchMethod fromXmlMethodName(String xmlMethodName)

Get the enumerated value for the given xml string.

Parameters:

xmlMethodName - the xml name.

Returns:

null if xmlMethodName is unknown.