Cytoscape 3.1.1 API

org.cytoscape.work
Enum FinishStatus.Type

java.lang.Object
  extended by java.lang.Enum<FinishStatus.Type>
      extended by org.cytoscape.work.FinishStatus.Type
All Implemented Interfaces:
Serializable, Comparable<FinishStatus.Type>
Enclosing class:
FinishStatus

public static enum FinishStatus.Type
extends Enum<FinishStatus.Type>


Enum Constant Summary
CANCELLED
          Indicates that the task iterator did not complete because one of its tasks was cancelled by the user.
FAILED
          Indicates that the task iterator did not complete because one of its tasks failed by throwing an exception.
SUCCEEDED
          Indicates that the task iterator completed each of its tasks successfully.
 
Method Summary
static FinishStatus.Type valueOf(String name)
          Returns the enum constant of this type with the specified name.
static FinishStatus.Type[] 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

SUCCEEDED

public static final FinishStatus.Type SUCCEEDED
Indicates that the task iterator completed each of its tasks successfully.


CANCELLED

public static final FinishStatus.Type CANCELLED
Indicates that the task iterator did not complete because one of its tasks was cancelled by the user.


FAILED

public static final FinishStatus.Type FAILED
Indicates that the task iterator did not complete because one of its tasks failed by throwing an exception.

Method Detail

values

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

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

valueOf

public static FinishStatus.Type 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

Cytoscape 3.1.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.