Package org.jetbrains.mps.openapi.util

Enum SubProgressKind

java.lang.Object

java.lang.Enum<SubProgressKind>

org.jetbrains.mps.openapi.util.SubProgressKind

All Implemented Interfaces:

Serializable, Comparable<SubProgressKind>

public enum SubProgressKind
extends Enum<SubProgressKind>

Defines several types of propagation of textual information (task and step names) from sub-tasks into the outer monitor Evgeny Gryaznov, 10/3/11

Enum Constant Summary

Enum Constants

Enum Constant	Description
AS_COMMENT	Task name is displayed as a step in the progress dialog Steps are never displayed
DEFAULT	Task name gets appended to the outer task name in the progress dialog header using the '::' separator Steps are normally displayed in the progress dialog
IGNORED	Neither task names nor steps are propagated
REPLACING	Replaces the outer task's task name with its own in the progress dialog header Steps are normally displayed in the progress dialog

Method Summary

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

DEFAULT

public static final SubProgressKind DEFAULT

Task name gets appended to the outer task name in the progress dialog header using the '::' separator Steps are normally displayed in the progress dialog

REPLACING

public static final SubProgressKind REPLACING

Replaces the outer task's task name with its own in the progress dialog header Steps are normally displayed in the progress dialog

AS_COMMENT

public static final SubProgressKind AS_COMMENT

Task name is displayed as a step in the progress dialog Steps are never displayed

IGNORED

public static final SubProgressKind IGNORED

Neither task names nor steps are propagated

Method Detail

values

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

Returns:

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

valueOf

public static SubProgressKind 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