Enum TupleType

java.lang.Object

java.lang.Enum<TupleType>

com.twelvemonkeys.imageio.plugins.pnm.TupleType

All Implemented Interfaces:

Serializable, Comparable<TupleType>, java.lang.constant.Constable

enum TupleType
extends Enum<TupleType>

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLACKANDWHITE	B/W, but uses 1 byte (8 bits) per pixel.
BLACKANDWHITE_ALPHA	B/W + bit mask, uses 2 bytes per pixel.
BLACKANDWHITE_WHITE_IS_ZERO	1 bit B/W.
CMYK	CMYK color.
CMYK_ALPHA	CMYK color + alpha.
GRAYSCALE	Grayscale, as PGM.
GRAYSCALE_ALPHA	Grayscale + alpha.
RGB	RGB color, as PPM.
RGB_ALPHA	RGB color + alpha.

Field Summary

Fields

Modifier and Type	Field	Description
private final int	maxMaxSample
private final int	minMaxSample
private final int	samplesPerPixel
private final int	transparency

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TupleType(int samplesPerPixel, int minMaxSample, int maxMaxSample, int transparency)

Method Summary

Modifier and Type	Method	Description
private static TupleType	filterPNM(TupleType tupleType)
(package private) static TupleType	forPAM(Raster raster)
(package private) static TupleType	forPAM(ImageTypeSpecifier type)
(package private) static TupleType	forPNM(Raster raster)
(package private) static TupleType	forPNM(ImageTypeSpecifier type)
int	getSamplesPerPixel()
int	getTransparency()
boolean	isValidMaxSample(int maxSample)
static TupleType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TupleType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BLACKANDWHITE

public static final TupleType BLACKANDWHITE

B/W, but uses 1 byte (8 bits) per pixel. Black is zero (opposite of PBM)

BLACKANDWHITE_ALPHA

public static final TupleType BLACKANDWHITE_ALPHA

B/W + bit mask, uses 2 bytes per pixel. Black is zero (opposite of PBM)

GRAYSCALE

public static final TupleType GRAYSCALE

Grayscale, as PGM.

GRAYSCALE_ALPHA

public static final TupleType GRAYSCALE_ALPHA

Grayscale + alpha. YA order.

RGB

public static final TupleType RGB

RGB color, as PPM. RGB order.

RGB_ALPHA

public static final TupleType RGB_ALPHA

RGB color + alpha. RGBA order.

CMYK

public static final TupleType CMYK

CMYK color. CMYK order.

CMYK_ALPHA

public static final TupleType CMYK_ALPHA

CMYK color + alpha. CMYKA order.

BLACKANDWHITE_WHITE_IS_ZERO

public static final TupleType BLACKANDWHITE_WHITE_IS_ZERO

1 bit B/W. White is zero (as PBM)

Field Details

samplesPerPixel

private final int samplesPerPixel

minMaxSample

private final int minMaxSample

maxMaxSample

private final int maxMaxSample

transparency

private final int transparency

Constructor Details

TupleType

private TupleType(int samplesPerPixel,
 int minMaxSample,
 int maxMaxSample,
 int transparency)

Method Details

values

public static TupleType[] values()

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

Returns:

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

valueOf

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

getTransparency

public int getTransparency()

getSamplesPerPixel

public int getSamplesPerPixel()

isValidMaxSample

public boolean isValidMaxSample(int maxSample)

forPNM

static TupleType forPNM(Raster raster)

forPNM

static TupleType forPNM(ImageTypeSpecifier type)

filterPNM

private static TupleType filterPNM(TupleType tupleType)

forPAM

static TupleType forPAM(Raster raster)

forPAM

static TupleType forPAM(ImageTypeSpecifier type)