Package ffx.xray.parallel

Enum Class GridMethod

java.lang.Object

java.lang.Enum<GridMethod>

ffx.xray.parallel.GridMethod

All Implemented Interfaces:

Serializable, Comparable<GridMethod>, Constable

public enum GridMethod
extends Enum<GridMethod>

Enum representing the different methods of grid processing.

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
ROW	Decompose into 1D rows.
SLICE	Decompose into 2D slices.
SPATIAL	Decompose into 3D special domains..

Method Summary

Modifier and Type	Method	Description
static GridMethod	parse(String methodName)	Parses the provided method name and returns the corresponding GridMethod enum value.
static GridMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GridMethod[]	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

SPATIAL

public static final GridMethod SPATIAL

Decompose into 3D special domains..

SLICE

public static final GridMethod SLICE

Decompose into 2D slices.

ROW

public static final GridMethod ROW

Decompose into 1D rows.

Method Details

values

public static GridMethod[] 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 GridMethod 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

parse

public static GridMethod parse(String methodName)

Parses the provided method name and returns the corresponding GridMethod enum value. If the provided method name is not recognized, the default value SLICE is returned.

Parameters:

methodName - the name of the grid method to parse (case-insensitive, trimming whitespace).

Returns:

the GridMethod corresponding to the provided method name.