Package org.apache.commons.imaging.formats.png

Enum PngColorType

java.lang.Object

java.lang.Enum<PngColorType>

org.apache.commons.imaging.formats.png.PngColorType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PngColorType>

public enum PngColorType
extends java.lang.Enum<PngColorType>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GREYSCALE
GREYSCALE_WITH_ALPHA
INDEXED_COLOR
TRUE_COLOR
TRUE_COLOR_WITH_ALPHA

Field Summary

Fields

Modifier and Type	Field	Description
private int[]	allowedBitDepths
private boolean	alpha
private boolean	greyscale
private int	samplesPerPixel
private int	value

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PngColorType(int value, boolean greyscale, boolean alpha, int samplesPerPixel, int[] allowedBitDepths)

Method Summary

Modifier and Type	Method	Description
(package private) static PngColorType	getColorType(boolean alpha, boolean grayscale)
static PngColorType	getColorType(int value)
(package private) int	getSamplesPerPixel()
(package private) int	getValue()
(package private) boolean	hasAlpha()
(package private) boolean	isBitDepthAllowed(int bitDepth)
(package private) boolean	isGreyscale()
static PngColorType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static PngColorType[]	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

GREYSCALE

public static final PngColorType GREYSCALE

TRUE_COLOR

public static final PngColorType TRUE_COLOR

INDEXED_COLOR

public static final PngColorType INDEXED_COLOR

GREYSCALE_WITH_ALPHA

public static final PngColorType GREYSCALE_WITH_ALPHA

TRUE_COLOR_WITH_ALPHA

public static final PngColorType TRUE_COLOR_WITH_ALPHA

Field Detail

value

private final int value

greyscale

private final boolean greyscale

alpha

private final boolean alpha

samplesPerPixel

private final int samplesPerPixel

allowedBitDepths

private final int[] allowedBitDepths

Constructor Detail

PngColorType

private PngColorType(int value,
                     boolean greyscale,
                     boolean alpha,
                     int samplesPerPixel,
                     int[] allowedBitDepths)

Method Detail

values

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

Returns:

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

valueOf

public static PngColorType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getColorType

static PngColorType getColorType(boolean alpha,
                                 boolean grayscale)

getColorType

public static PngColorType getColorType(int value)

getSamplesPerPixel

int getSamplesPerPixel()

getValue

int getValue()

hasAlpha

boolean hasAlpha()

isBitDepthAllowed

boolean isBitDepthAllowed(int bitDepth)

isGreyscale

boolean isGreyscale()