org.openimaj.image

Enum ARGBPlane

java.lang.Object

java.lang.Enum<ARGBPlane>

org.openimaj.image.ARGBPlane

All Implemented Interfaces:

Serializable, Comparable<ARGBPlane>

public enum ARGBPlane
extends Enum<ARGBPlane>

Enumerator for enumerating the planes of an RGB image.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALPHA Use Alpha plane
BLUE Use Blue plane
GREEN Use Green plane
RED Use Red plane

Method Summary

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

ALPHA

public static final ARGBPlane ALPHA

Use Alpha plane

RED

public static final ARGBPlane RED

Use Red plane

GREEN

public static final ARGBPlane GREEN

Use Green plane

BLUE

public static final ARGBPlane BLUE

Use Blue plane

Method Detail

values

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

Returns:

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

valueOf

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