Package fr.ens.biologie.genomique.eoulsan.core

Enum Step.DiscardOutput

java.lang.Object

java.lang.Enum<Step.DiscardOutput>

fr.ens.biologie.genomique.eoulsan.core.Step.DiscardOutput

All Implemented Interfaces:

Serializable, Comparable<Step.DiscardOutput>

Enclosing interface:

Step

public static enum Step.DiscardOutput
extends Enum<Step.DiscardOutput>

This enum define the value of the discard output attribute of the step tag in the Eoulsan workflow file.

Since:

2.0

Author:

Laurent Jourdren

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASAP
NO
SUCCESS

Method Summary

Modifier and Type	Method	Description
boolean	isCopyResultsToOutput()	Test if result must be copied to output.
static Step.DiscardOutput	parse(String s)	This method define a parser for the values of the "discardoutput" attribute of the Eoulsan workflow.
static Step.DiscardOutput	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Step.DiscardOutput[]	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

NO

public static final Step.DiscardOutput NO

ASAP

public static final Step.DiscardOutput ASAP

SUCCESS

public static final Step.DiscardOutput SUCCESS

Method Detail

values

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

Returns:

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

valueOf

public static Step.DiscardOutput 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

isCopyResultsToOutput

public boolean isCopyResultsToOutput()

Test if result must be copied to output.

Returns:

true if result must be copied to output

parse

public static Step.DiscardOutput parse(String s)
                                throws EoulsanException

This method define a parser for the values of the "discardoutput" attribute of the Eoulsan workflow.

Parameters:

s - the input string

Returns:

a DiscardOutput value

Throws:

EoulsanException - if the attribute value is unknown