magpie.data.utilities.output

Enum CompositionOutput.ElementSelectionMethod

java.lang.Object

java.lang.Enum<CompositionOutput.ElementSelectionMethod>

magpie.data.utilities.output.CompositionOutput.ElementSelectionMethod

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CompositionOutput.ElementSelectionMethod>

Enclosing class:

CompositionOutput

public static enum CompositionOutput.ElementSelectionMethod
extends java.lang.Enum<CompositionOutput.ElementSelectionMethod>

How to determine which elements to print

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_ELEMENTS Print all known elements
DYNAMIC Determine list of elements from dataset being printed
USER_DEFINED Print a user defined list

Method Summary

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

ALL_ELEMENTS

public static final CompositionOutput.ElementSelectionMethod ALL_ELEMENTS

Print all known elements

USER_DEFINED

public static final CompositionOutput.ElementSelectionMethod USER_DEFINED

Print a user defined list

DYNAMIC

public static final CompositionOutput.ElementSelectionMethod DYNAMIC

Determine list of elements from dataset being printed

Method Detail

values

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

Returns:

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

valueOf

public static CompositionOutput.ElementSelectionMethod valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null