org.cytoscape.util.color

Enum BrewerType

java.lang.Object

java.lang.Enum<BrewerType>

org.cytoscape.util.color.BrewerType

All Implemented Interfaces:

Serializable, Comparable<BrewerType>, PaletteType

public enum BrewerType
extends Enum<BrewerType>
implements PaletteType

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY Any (or all) palettes
DIVERGING Diverging palettes -- typically used to represent centered data with extremes in either direction.
QUALITATIVE Qualitative palettes -- typically used to represent categorical data.
SEQUENTIAL Sequential palettes -- typically used to represent ordered data that progresses from low to high.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DIVERGING

public static final BrewerType DIVERGING

Diverging palettes -- typically used to represent centered data with extremes in either direction. In Cytoscape, these palettes might be used for a continuous mapping that has both positive and nevative values.

QUALITATIVE

public static final BrewerType QUALITATIVE

Qualitative palettes -- typically used to represent categorical data. Choose this kind of palette for discrate mappings.

SEQUENTIAL

public static final BrewerType SEQUENTIAL

Sequential palettes -- typically used to represent ordered data that progresses from low to high. In Cytoscape, these palettes might be used for a continuous mapping that has either positive or negative values, but not both.

ANY

public static final BrewerType ANY

Any (or all) palettes

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Specified by:

toString in interface PaletteType

Overrides:

toString in class Enum<BrewerType>