Cytoscape 3.1.1 API

org.cytoscape.work
Enum TaskMonitor.Level

java.lang.Object
  extended by java.lang.Enum<TaskMonitor.Level>
      extended by org.cytoscape.work.TaskMonitor.Level
All Implemented Interfaces:
Serializable, Comparable<TaskMonitor.Level>
Enclosing interface:
TaskMonitor

public static enum TaskMonitor.Level
extends Enum<TaskMonitor.Level>

Used by the showMessage method to indicate the severity of the message.


Enum Constant Summary
ERROR
          A message that informs the user that a non-recoverable error has occured.
INFO
          A message that is informational to the user.
WARN
          A message that warns the user about recoverable errors the task has experienced.
 
Method Summary
static TaskMonitor.Level valueOf(String name)
          Returns the enum constant of this type with the specified name.
static TaskMonitor.Level[] 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

INFO

public static final TaskMonitor.Level INFO
A message that is informational to the user.


WARN

public static final TaskMonitor.Level WARN
A message that warns the user about recoverable errors the task has experienced.


ERROR

public static final TaskMonitor.Level ERROR
A message that informs the user that a non-recoverable error has occured. Typically after an error message has been shown, the task should stop execution.

Method Detail

values

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

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

valueOf

public static TaskMonitor.Level 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.