org.geotools.ysld

Enum Band

Object

Enum<Band>

Band

All Implemented Interfaces:

Serializable, Comparable<Band>

public enum Band
extends Enum<Band>

Enumeration for valid raster band values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLUE
GRAY
GREEN
RED

Field Summary

Fields

Modifier and Type	Field and Description
String	key
static List<Band>	RGB A list of the bands representing Red, Green, Blue (in order).

Method Summary

Modifier and Type	Method and Description
abstract SelectedChannelType	getFrom(ChannelSelection sel) Get the SelectedChannelType in sel that is represented by this band.
abstract void	setTo(ChannelSelection sel, SelectedChannelType chan) Set the SelectedChannelType in sel that is represented by this band to chan.
static Band	valueOf(String name) Returns the enum constant of this type with the specified name.
static Band[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GRAY

public static final Band GRAY

RED

public static final Band RED

GREEN

public static final Band GREEN

BLUE

public static final Band BLUE

Field Detail

RGB

public static final List<Band> RGB

A list of the bands representing Red, Green, Blue (in order).

key

public final String key

Method Detail

values

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

Returns:

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

valueOf

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

getFrom

public abstract SelectedChannelType getFrom(ChannelSelection sel)

Get the SelectedChannelType in sel that is represented by this band.

setTo

public abstract void setTo(ChannelSelection sel,
                           SelectedChannelType chan)

Set the SelectedChannelType in sel that is represented by this band to chan.