edu.umd.cs.findbugs.annotations

Class When

public class When extends Enum<When>

Author: pugh

Field Summary
static WhenANYTIME
static WhenFIRST
static WhenLAST
static List<When>VALUES
An immutable list containing the values comprising this enum class in the order they're declared.
Method Summary
List<When>family()
Returns an immutable list containing the values comprising this enum class in the order they're declared.
static WhenvalueOf(String name)
Static factory to return the enum constant pertaining to the given string name.

Field Detail

ANYTIME

public static final When ANYTIME

FIRST

public static final When FIRST

LAST

public static final When LAST

VALUES

public static final List<When> VALUES
An immutable list containing the values comprising this enum class in the order they're declared. This field may be used to iterate over the constants as follows:
for(When c : When.VALUES)
    System.out.println(c);

Method Detail

family

public final List<When> family()
Returns an immutable list containing the values comprising this enum class in the order they're declared. This instance method simply returns VALUES. Few programmers should have any need to use this method. It is provided for use by sophisticated enum-based data structures to prevent the need for reflective access to VALUES.

Returns: an immutable list containing the values comprising this enum class, in the order they're declared.

valueOf

public static final When valueOf(String name)
Static factory to return the enum constant pertaining to the given string name. The string must match exactly an identifier used to declare an enum constant in this type.

Throws: IllegalArgumentException if this enum class has no constant with the specified name.

FindBugs™ is licenced under the LGPL. Copyright © 2006 University of Maryland.