Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	ImageTypeSpecifier.Banded
pack-priv static class	ImageTypeSpecifier.Grayscale
pack-priv static class	ImageTypeSpecifier.Indexed
pack-priv static class	ImageTypeSpecifier.Interleaved
pack-priv static class	ImageTypeSpecifier.Packed

Field Summary

Modifier and Type	Field and Description
private static ImageTypeSpecifier[]	BISpecifier Cached specifiers for all of the standard `BufferedImage` types.
protected ColorModel	colorModel The `ColorModel` to be used as a prototype.
protected SampleModel	sampleModel A `SampleModel` to be used as a prototype.
private static ColorSpace	sRGB

Constructor Summary

Access	Constructor and Description
private	ImageTypeSpecifier() A constructor to be used by inner subclasses only.
public	ImageTypeSpecifier(ColorModel a `ColorModel`. colorModel, SampleModel a `SampleModel`. sampleModel) Constructs an `ImageTypeSpecifier` directly from a `ColorModel` and a `SampleModel`.
public	ImageTypeSpecifier(RenderedImage a `RenderedImage`. image) Constructs an `ImageTypeSpecifier` from a `RenderedImage`.

Method Summary

Modifier and Type	Method and Description
public static ImageTypeSpecifier	Returns: an `ImageTypeSpecifier` with the desired characteristics. createBanded(ColorSpace the desired `ColorSpace`. colorSpace, int[] an array of `int`s indicating the bank in which each band will be stored. bankIndices, int[] an array of `int`s indicating the starting offset of each band within its bank. bandOffsets, int the desired data type, as one of the enumerations from the `DataBuffer` class. dataType, boolean `true` if an alpha channel is desired. hasAlpha, boolean `true` if the color channels will be premultipled by the alpha channel. isAlphaPremultiplied) Returns a specifier for a banded image format that will use a `ComponentColorModel` and a `BandedSampleModel` to store each channel in a separate array.
public BufferedImage	Returns: a new `BufferedImage` createBufferedImage(int the desired width of the returned `BufferedImage`. width, int the desired height of the returned `BufferedImage`. height) Creates a `BufferedImage` with a given width and height according to the specification embodied in this object.
pack-priv static ColorModel	createComponentCM(ColorSpace colorSpace, int numBands, int dataType, boolean hasAlpha, boolean isAlphaPremultiplied)
public static ImageTypeSpecifier	Returns: an `ImageTypeSpecifier` with the desired characteristics. createFromBufferedImageType(int an int representing one of the standard `BufferedImage` types. bufferedImageType) Returns an `ImageTypeSpecifier` that encodes one of the standard `BufferedImage` types (other than `TYPE_CUSTOM`).
public static ImageTypeSpecifier	Returns: an `ImageTypeSpecifier` with the desired characteristics. createFromRenderedImage(RenderedImage a `RenderedImage`. image) Returns an `ImageTypeSpecifier` that encodes the layout of a `RenderedImage` (which may be a `BufferedImage`).
public static ImageTypeSpecifier	Returns: an `ImageTypeSpecifier` with the desired characteristics. createGrayscale(int the number of bits per gray value (1, 2, 4, 8, or 16). bits, int the desired data type, as one of the enumerations from the `DataBuffer` class. dataType, boolean `true` if negative values are to be represented. isSigned) Returns a specifier for a grayscale image format that will pack pixels of the given bit depth into array elements of the specified data type.
public static ImageTypeSpecifier	Returns: an `ImageTypeSpecifier` with the desired characteristics. createGrayscale(int the number of bits per gray value (1, 2, 4, 8, or 16). bits, int the desired data type, as one of the enumerations from the `DataBuffer` class. dataType, boolean `true` if negative values are to be represented. isSigned, boolean `true` if the luminance channel will be premultipled by the alpha channel. isAlphaPremultiplied) Returns a specifier for a grayscale plus alpha image format that will pack pixels of the given bit depth into array elements of the specified data type.
public static ImageTypeSpecifier	Returns: an `ImageTypeSpecifier` with the desired characteristics. createIndexed(byte[] an array of `byte`s containing the red values for each index. redLUT, byte[] an array of `byte`s containing * the green values for each index. greenLUT, byte[] an array of `byte`s containing the blue values for each index. blueLUT, byte[] an array of `byte`s containing the alpha values for each index, or `null` to create a fully opaque LUT. alphaLUT, int the number of bits in each index. bits, int the desired output type, as one of the enumerations from the `DataBuffer` class. dataType) Returns a specifier for an indexed-color image format that will pack index values of the given bit depth into array elements of the specified data type.
public static ImageTypeSpecifier	Returns: an `ImageTypeSpecifier` with the desired characteristics. createInterleaved(ColorSpace the desired `ColorSpace`. colorSpace, int[] an array of `int`s indicating the offsets for each band. bandOffsets, int the desired data type, as one of the enumerations from the `DataBuffer` class. dataType, boolean `true` if an alpha channel is desired. hasAlpha, boolean `true` if the color channels will be premultipled by the alpha channel. isAlphaPremultiplied) Returns a specifier for an interleaved image format that will use a `ComponentColorModel` and a `PixelInterleavedSampleModel` to store each pixel component in a separate byte, short, or int.
public static ImageTypeSpecifier	Returns: an `ImageTypeSpecifier` with the desired characteristics. createPacked(ColorSpace the desired `ColorSpace`. colorSpace, int a contiguous mask indicated the position of the red channel. redMask, int a contiguous mask indicated the position of the green channel. greenMask, int a contiguous mask indicated the position of the blue channel. blueMask, int a contiguous mask indicated the position of the alpha channel. alphaMask, int the desired `SampleModel` transfer type. transferType, boolean `true` if the color channels will be premultipled by the alpha channel. isAlphaPremultiplied) Returns a specifier for a packed image format that will use a `DirectColorModel` and a packed `SampleModel` to store each pixel packed into in a single byte, short, or int.
private static ImageTypeSpecifier	createSpecifier(int type)
public boolean	Returns: `true` if the given object is an equivalent `ImageTypeSpecifier`. equals(Object the `Object` to be compared for equality. o) Overrides java.lang.Object.equals. Returns `true` if the given `Object` is an `ImageTypeSpecifier` and has a `SampleModel` and `ColorModel` that are equal to those of this object.
public int	Returns: an int specifying a number of bits. getBitsPerBand(int the index of the band to be queried, as an int. band) Return the number of bits used to represent samples of the given band.
public int	Returns: an `int` representing a `BufferedImage` type. getBufferedImageType() Returns an int containing one of the enumerated constant values describing image formats from `BufferedImage`.
public ColorModel	Returns: a `ColorModel`. getColorModel() Returns the `ColorModel` specified by this object.
public int	Returns: the number of bands in the image. getNumBands() Return the number of bands specified by this object.
public int	Returns: the number of components in the image. getNumComponents() Return the number of color components specified by this object.
public SampleModel	Returns: a `SampleModel` with arbitrary dimensions. getSampleModel() Returns a `SampleModel` based on the settings encapsulated within this object.
public SampleModel	Returns: a `SampleModel` with the given dimensions. getSampleModel(int the desired width of the returned `SampleModel`. width, int the desired height of the returned `SampleModel`. height) Returns a `SampleModel` based on the settings encapsulated within this object.
private static ImageTypeSpecifier	getSpecifier(int type)
public int	Returns: a hash code for this ImageTypeSpecifier hashCode() Overrides java.lang.Object.hashCode. Returns the hash code for this ImageTypeSpecifier.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

BISpecifier	back to summary
private static ImageTypeSpecifier[] BISpecifier Cached specifiers for all of the standard `BufferedImage` types.

colorModel	back to summary
protected ColorModel colorModel The `ColorModel` to be used as a prototype.

sampleModel	back to summary
protected SampleModel sampleModel A `SampleModel` to be used as a prototype.

sRGB	back to summary
private static ColorSpace sRGB

Constructor Detail

ImageTypeSpecifier	back to summary
private ImageTypeSpecifier() A constructor to be used by inner subclasses only.

ImageTypeSpecifier back to summary

ImageTypeSpecifier	back to summary
public ImageTypeSpecifier(ColorModel colorModel, SampleModel sampleModel) Constructs an `ImageTypeSpecifier` directly from a `ColorModel` and a `SampleModel`. It is the caller's responsibility to supply compatible parameters. Parameters colorModel:ColorModel a `ColorModel`. sampleModel:SampleModel a `SampleModel`. Exceptions IllegalArgumentException: if either parameter is `null`. if `sampleModel` is not compatible with `colorModel`.

public ImageTypeSpecifier(ColorModel colorModel, SampleModel sampleModel)

Constructs an ImageTypeSpecifier directly from a ColorModel and a SampleModel. It is the caller's responsibility to supply compatible parameters.

Parameters

colorModel:ColorModel: a ColorModel.
sampleModel:SampleModel: a SampleModel.

Exceptions

IllegalArgumentException:

if either parameter is null.
if sampleModel is not compatible with colorModel.

ImageTypeSpecifier back to summary

ImageTypeSpecifier	back to summary
public ImageTypeSpecifier(RenderedImage image) Constructs an `ImageTypeSpecifier` from a `RenderedImage`. If a `BufferedImage` is being used, one of the factory methods `createFromRenderedImage` or `createFromBufferedImageType` should be used instead in order to get a more accurate result. Parameters image:RenderedImage a `RenderedImage`. Exceptions IllegalArgumentException: if the argument is `null`.

public ImageTypeSpecifier(RenderedImage image)

Constructs an ImageTypeSpecifier from a RenderedImage. If a BufferedImage is being used, one of the factory methods createFromRenderedImage or createFromBufferedImageType should be used instead in order to get a more accurate result.

Parameters

image:RenderedImage: a RenderedImage.

Exceptions

IllegalArgumentException:: if the argument is null.

Method Detail

createBanded back to summary

createBanded	back to summary
public static ImageTypeSpecifier createBanded(ColorSpace colorSpace, int[] bankIndices, int[] bandOffsets, int dataType, boolean hasAlpha, boolean isAlphaPremultiplied) Returns a specifier for a banded image format that will use a `ComponentColorModel` and a `BandedSampleModel` to store each channel in a separate array. Parameters colorSpace:ColorSpace the desired `ColorSpace`. bankIndices:int[] an array of `int`s indicating the bank in which each band will be stored. bandOffsets:int[] an array of `int`s indicating the starting offset of each band within its bank. dataType:int the desired data type, as one of the enumerations from the `DataBuffer` class. hasAlpha:boolean `true` if an alpha channel is desired. isAlphaPremultiplied:boolean `true` if the color channels will be premultipled by the alpha channel. Returns:ImageTypeSpecifier an `ImageTypeSpecifier` with the desired characteristics. Exceptions IllegalArgumentException: if `colorSpace` is `null`. if `bankIndices` is `null`. if `bandOffsets` is `null`. if the lengths of `bankIndices` and `bandOffsets` differ. if `bandOffsets.length` does not equal the number of color space components, plus 1 if `hasAlpha` is `true`. if `dataType` is not one of the legal `DataBuffer.TYPE_*` constants.

public static ImageTypeSpecifier createBanded(ColorSpace colorSpace, int[] bankIndices, int[] bandOffsets, int dataType, boolean hasAlpha, boolean isAlphaPremultiplied)

Returns a specifier for a banded image format that will use a ComponentColorModel and a BandedSampleModel to store each channel in a separate array.

Parameters

colorSpace:ColorSpace: the desired ColorSpace.
bankIndices:int[]: an array of ints indicating the bank in which each band will be stored.
bandOffsets:int[]: an array of ints indicating the starting offset of each band within its bank.
dataType:int: the desired data type, as one of the enumerations from the DataBuffer class.
hasAlpha:boolean: true if an alpha channel is desired.
isAlphaPremultiplied:boolean: true if the color channels will be premultipled by the alpha channel.

Returns:ImageTypeSpecifier

an ImageTypeSpecifier with the desired characteristics.

Exceptions

IllegalArgumentException:

if colorSpace is null.
if bankIndices is null.
if bandOffsets is null.
if the lengths of bankIndices and bandOffsets differ.
if bandOffsets.length does not equal the number of color space components, plus 1 if hasAlpha is true.
if dataType is not one of the legal DataBuffer.TYPE_* constants.

createBufferedImage back to summary

createBufferedImage	back to summary
public BufferedImage createBufferedImage(int width, int height) Creates a `BufferedImage` with a given width and height according to the specification embodied in this object. Parameters width:int the desired width of the returned `BufferedImage`. height:int the desired height of the returned `BufferedImage`. Returns:BufferedImage a new `BufferedImage` Exceptions IllegalArgumentException: if either `width` or `height` are negative or zero. if the product of `width` and `height` is greater than `Integer.MAX_VALUE`, or if the number of array elements needed to store the image is greater than `Integer.MAX_VALUE`.

public BufferedImage createBufferedImage(int width, int height)

Creates a BufferedImage with a given width and height according to the specification embodied in this object.

Parameters

width:int: the desired width of the returned BufferedImage.
height:int: the desired height of the returned BufferedImage.

Returns:BufferedImage

a new BufferedImage

Exceptions

IllegalArgumentException:

if either width or height are negative or zero.
if the product of width and height is greater than Integer.MAX_VALUE, or if the number of array elements needed to store the image is greater than Integer.MAX_VALUE.

createComponentCM	back to summary
pack-priv static ColorModel createComponentCM(ColorSpace colorSpace, int numBands, int dataType, boolean hasAlpha, boolean isAlphaPremultiplied)

createFromBufferedImageType back to summary

createFromBufferedImageType	back to summary
public static ImageTypeSpecifier createFromBufferedImageType(int bufferedImageType) Returns an `ImageTypeSpecifier` that encodes one of the standard `BufferedImage` types (other than `TYPE_CUSTOM`). Parameters bufferedImageType:int an int representing one of the standard `BufferedImage` types. Returns:ImageTypeSpecifier an `ImageTypeSpecifier` with the desired characteristics. Exceptions IllegalArgumentException: if `bufferedImageType` is not one of the standard types, or is equal to `TYPE_CUSTOM`. See Also `java.awt.image.BufferedImage`, `java.awt.image.BufferedImage#TYPE_INT_RGB`, `java.awt.image.BufferedImage#TYPE_INT_ARGB`, `java.awt.image.BufferedImage#TYPE_INT_ARGB_PRE`, `java.awt.image.BufferedImage#TYPE_INT_BGR`, `java.awt.image.BufferedImage#TYPE_3BYTE_BGR`, `java.awt.image.BufferedImage#TYPE_4BYTE_ABGR`, `java.awt.image.BufferedImage#TYPE_4BYTE_ABGR_PRE`, `java.awt.image.BufferedImage#TYPE_USHORT_565_RGB`, `java.awt.image.BufferedImage#TYPE_USHORT_555_RGB`, `java.awt.image.BufferedImage#TYPE_BYTE_GRAY`, `java.awt.image.BufferedImage#TYPE_USHORT_GRAY`, `java.awt.image.BufferedImage#TYPE_BYTE_BINARY`, `java.awt.image.BufferedImage#TYPE_BYTE_INDEXED`

public static ImageTypeSpecifier createFromBufferedImageType(int bufferedImageType)

Returns an ImageTypeSpecifier that encodes one of the standard BufferedImage types (other than TYPE_CUSTOM).

Parameters

bufferedImageType:int: an int representing one of the standard BufferedImage types.

Returns:ImageTypeSpecifier

an ImageTypeSpecifier with the desired characteristics.

Exceptions

IllegalArgumentException:: if bufferedImageType is not one of the standard types, or is equal to TYPE_CUSTOM.

createFromRenderedImage back to summary

createFromRenderedImage	back to summary
public static ImageTypeSpecifier createFromRenderedImage(RenderedImage image) Returns an `ImageTypeSpecifier` that encodes the layout of a `RenderedImage` (which may be a `BufferedImage`). Parameters image:RenderedImage a `RenderedImage`. Returns:ImageTypeSpecifier an `ImageTypeSpecifier` with the desired characteristics. Exceptions IllegalArgumentException: if `image` is `null`.

public static ImageTypeSpecifier createFromRenderedImage(RenderedImage image)

Returns an ImageTypeSpecifier that encodes the layout of a RenderedImage (which may be a BufferedImage).

Parameters

image:RenderedImage: a RenderedImage.

Returns:ImageTypeSpecifier

an ImageTypeSpecifier with the desired characteristics.

Exceptions

IllegalArgumentException:: if image is null.

createGrayscale back to summary

createGrayscale	back to summary
public static ImageTypeSpecifier createGrayscale(int bits, int dataType, boolean isSigned) Returns a specifier for a grayscale image format that will pack pixels of the given bit depth into array elements of the specified data type. Parameters bits:int the number of bits per gray value (1, 2, 4, 8, or 16). dataType:int the desired data type, as one of the enumerations from the `DataBuffer` class. isSigned:boolean `true` if negative values are to be represented. Returns:ImageTypeSpecifier an `ImageTypeSpecifier` with the desired characteristics. Exceptions IllegalArgumentException: if `bits` is not one of 1, 2, 4, 8, or 16. if `dataType` is not one of `DataBuffer.TYPE_BYTE`, `DataBuffer.TYPE_SHORT`, or `DataBuffer.TYPE_USHORT`. if `bits` is larger than the bit size of the given `dataType`.

public static ImageTypeSpecifier createGrayscale(int bits, int dataType, boolean isSigned)

Returns a specifier for a grayscale image format that will pack pixels of the given bit depth into array elements of the specified data type.

Parameters

bits:int: the number of bits per gray value (1, 2, 4, 8, or 16).
dataType:int: the desired data type, as one of the enumerations from the DataBuffer class.
isSigned:boolean: true if negative values are to be represented.

Returns:ImageTypeSpecifier

an ImageTypeSpecifier with the desired characteristics.

Exceptions

IllegalArgumentException:

if bits is not one of 1, 2, 4, 8, or 16.
if dataType is not one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_SHORT, or DataBuffer.TYPE_USHORT.
if bits is larger than the bit size of the given dataType.

createGrayscale back to summary

createGrayscale	back to summary
public static ImageTypeSpecifier createGrayscale(int bits, int dataType, boolean isSigned, boolean isAlphaPremultiplied) Returns a specifier for a grayscale plus alpha image format that will pack pixels of the given bit depth into array elements of the specified data type. Parameters bits:int the number of bits per gray value (1, 2, 4, 8, or 16). dataType:int the desired data type, as one of the enumerations from the `DataBuffer` class. isSigned:boolean `true` if negative values are to be represented. isAlphaPremultiplied:boolean `true` if the luminance channel will be premultipled by the alpha channel. Returns:ImageTypeSpecifier an `ImageTypeSpecifier` with the desired characteristics. Exceptions IllegalArgumentException: if `bits` is not one of 1, 2, 4, 8, or 16. if `dataType` is not one of `DataBuffer.TYPE_BYTE`, `DataBuffer.TYPE_SHORT`, or `DataBuffer.TYPE_USHORT`. if `bits` is larger than the bit size of the given `dataType`.

public static ImageTypeSpecifier createGrayscale(int bits, int dataType, boolean isSigned, boolean isAlphaPremultiplied)

Returns a specifier for a grayscale plus alpha image format that will pack pixels of the given bit depth into array elements of the specified data type.

Parameters

bits:int: the number of bits per gray value (1, 2, 4, 8, or 16).
dataType:int: the desired data type, as one of the enumerations from the DataBuffer class.
isSigned:boolean: true if negative values are to be represented.
isAlphaPremultiplied:boolean: true if the luminance channel will be premultipled by the alpha channel.

Returns:ImageTypeSpecifier

an ImageTypeSpecifier with the desired characteristics.

Exceptions

IllegalArgumentException:

if bits is not one of 1, 2, 4, 8, or 16.
if dataType is not one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_SHORT, or DataBuffer.TYPE_USHORT.
if bits is larger than the bit size of the given dataType.

createIndexed back to summary

createIndexed	back to summary
public static ImageTypeSpecifier createIndexed(byte[] redLUT, byte[] greenLUT, byte[] blueLUT, byte[] alphaLUT, int bits, int dataType) Returns a specifier for an indexed-color image format that will pack index values of the given bit depth into array elements of the specified data type. Parameters redLUT:byte[] an array of `byte`s containing the red values for each index. greenLUT:byte[] an array of `byte`s containing * the green values for each index. blueLUT:byte[] an array of `byte`s containing the blue values for each index. alphaLUT:byte[] an array of `byte`s containing the alpha values for each index, or `null` to create a fully opaque LUT. bits:int the number of bits in each index. dataType:int the desired output type, as one of the enumerations from the `DataBuffer` class. Returns:ImageTypeSpecifier an `ImageTypeSpecifier` with the desired characteristics. Exceptions IllegalArgumentException: if `redLUT` is `null`. if `greenLUT` is `null`. if `blueLUT` is `null`. if `bits` is not one of 1, 2, 4, 8, or 16. if the non-`null` LUT parameters do not have lengths of exactly `1 << bits`. if `dataType` is not one of `DataBuffer.TYPE_BYTE`, `DataBuffer.TYPE_SHORT`, `DataBuffer.TYPE_USHORT`, or `DataBuffer.TYPE_INT`. if `bits` is larger than the bit size of the given `dataType`.

public static ImageTypeSpecifier createIndexed(byte[] redLUT, byte[] greenLUT, byte[] blueLUT, byte[] alphaLUT, int bits, int dataType)

Returns a specifier for an indexed-color image format that will pack index values of the given bit depth into array elements of the specified data type.

Parameters

redLUT:byte[]: an array of bytes containing the red values for each index.
greenLUT:byte[]: an array of bytes containing * the green values for each index.
blueLUT:byte[]: an array of bytes containing the blue values for each index.
alphaLUT:byte[]: an array of bytes containing the alpha values for each index, or null to create a fully opaque LUT.
bits:int: the number of bits in each index.
dataType:int: the desired output type, as one of the enumerations from the DataBuffer class.

Returns:ImageTypeSpecifier

an ImageTypeSpecifier with the desired characteristics.

Exceptions

IllegalArgumentException:

if redLUT is null.
if greenLUT is null.
if blueLUT is null.
if bits is not one of 1, 2, 4, 8, or 16.
if the non-null LUT parameters do not have lengths of exactly 1 << bits.
if dataType is not one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_SHORT, DataBuffer.TYPE_USHORT, or DataBuffer.TYPE_INT.
if bits is larger than the bit size of the given dataType.

createInterleaved back to summary

createInterleaved	back to summary
public static ImageTypeSpecifier createInterleaved(ColorSpace colorSpace, int[] bandOffsets, int dataType, boolean hasAlpha, boolean isAlphaPremultiplied) Returns a specifier for an interleaved image format that will use a `ComponentColorModel` and a `PixelInterleavedSampleModel` to store each pixel component in a separate byte, short, or int. Parameters colorSpace:ColorSpace the desired `ColorSpace`. bandOffsets:int[] an array of `int`s indicating the offsets for each band. dataType:int the desired data type, as one of the enumerations from the `DataBuffer` class. hasAlpha:boolean `true` if an alpha channel is desired. isAlphaPremultiplied:boolean `true` if the color channels will be premultipled by the alpha channel. Returns:ImageTypeSpecifier an `ImageTypeSpecifier` with the desired characteristics. Exceptions IllegalArgumentException: if `colorSpace` is `null`. if `bandOffsets` is `null`. if `dataType` is not one of the legal `DataBuffer.TYPE_*` constants. if `bandOffsets.length` does not equal the number of color space components, plus 1 if `hasAlpha` is `true`.

public static ImageTypeSpecifier createInterleaved(ColorSpace colorSpace, int[] bandOffsets, int dataType, boolean hasAlpha, boolean isAlphaPremultiplied)

Returns a specifier for an interleaved image format that will use a ComponentColorModel and a PixelInterleavedSampleModel to store each pixel component in a separate byte, short, or int.

Parameters

colorSpace:ColorSpace: the desired ColorSpace.
bandOffsets:int[]: an array of ints indicating the offsets for each band.
dataType:int: the desired data type, as one of the enumerations from the DataBuffer class.
hasAlpha:boolean: true if an alpha channel is desired.
isAlphaPremultiplied:boolean: true if the color channels will be premultipled by the alpha channel.

Returns:ImageTypeSpecifier

an ImageTypeSpecifier with the desired characteristics.

Exceptions

IllegalArgumentException:

if colorSpace is null.
if bandOffsets is null.
if dataType is not one of the legal DataBuffer.TYPE_* constants.
if bandOffsets.length does not equal the number of color space components, plus 1 if hasAlpha is true.

createPacked back to summary

createPacked	back to summary
public static ImageTypeSpecifier createPacked(ColorSpace colorSpace, int redMask, int greenMask, int blueMask, int alphaMask, int transferType, boolean isAlphaPremultiplied) Returns a specifier for a packed image format that will use a `DirectColorModel` and a packed `SampleModel` to store each pixel packed into in a single byte, short, or int. Parameters colorSpace:ColorSpace the desired `ColorSpace`. redMask:int a contiguous mask indicated the position of the red channel. greenMask:int a contiguous mask indicated the position of the green channel. blueMask:int a contiguous mask indicated the position of the blue channel. alphaMask:int a contiguous mask indicated the position of the alpha channel. transferType:int the desired `SampleModel` transfer type. isAlphaPremultiplied:boolean `true` if the color channels will be premultipled by the alpha channel. Returns:ImageTypeSpecifier an `ImageTypeSpecifier` with the desired characteristics. Exceptions IllegalArgumentException: if `colorSpace` is `null`. if `colorSpace` is not of type `TYPE_RGB`. if no mask has at least 1 bit set. if `transferType` if not one of `DataBuffer.TYPE_BYTE`, `DataBuffer.TYPE_USHORT`, or `DataBuffer.TYPE_INT`.

public static ImageTypeSpecifier createPacked(ColorSpace colorSpace, int redMask, int greenMask, int blueMask, int alphaMask, int transferType, boolean isAlphaPremultiplied)

Returns a specifier for a packed image format that will use a DirectColorModel and a packed SampleModel to store each pixel packed into in a single byte, short, or int.

Parameters

colorSpace:ColorSpace: the desired ColorSpace.
redMask:int: a contiguous mask indicated the position of the red channel.
greenMask:int: a contiguous mask indicated the position of the green channel.
blueMask:int: a contiguous mask indicated the position of the blue channel.
alphaMask:int: a contiguous mask indicated the position of the alpha channel.
transferType:int: the desired SampleModel transfer type.
isAlphaPremultiplied:boolean: true if the color channels will be premultipled by the alpha channel.

Returns:ImageTypeSpecifier

an ImageTypeSpecifier with the desired characteristics.

Exceptions

IllegalArgumentException:

if colorSpace is null.
if colorSpace is not of type TYPE_RGB.
if no mask has at least 1 bit set.
if transferType if not one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, or DataBuffer.TYPE_INT.

createSpecifier	back to summary
private static ImageTypeSpecifier createSpecifier(int type)

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Returns `true` if the given `Object` is an `ImageTypeSpecifier` and has a `SampleModel` and `ColorModel` that are equal to those of this object. Parameters o:Object the `Object` to be compared for equality. Returns:boolean `true` if the given object is an equivalent `ImageTypeSpecifier`.

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Returns true if the given Object is an ImageTypeSpecifier and has a SampleModel and ColorModel that are equal to those of this object.

Parameters

o:Object: the Object to be compared for equality.

Returns:boolean

true if the given object is an equivalent ImageTypeSpecifier.

getBitsPerBand back to summary

getBitsPerBand	back to summary
public int getBitsPerBand(int band) Return the number of bits used to represent samples of the given band. Parameters band:int the index of the band to be queried, as an int. Returns:int an int specifying a number of bits. Exceptions IllegalArgumentException: if `band` is negative or greater than the largest band index.

public int getBitsPerBand(int band)

Return the number of bits used to represent samples of the given band.

Parameters

band:int: the index of the band to be queried, as an int.

Returns:int

an int specifying a number of bits.

Exceptions

IllegalArgumentException:: if band is negative or greater than the largest band index.

getBufferedImageType back to summary

getBufferedImageType	back to summary
public int getBufferedImageType() Returns an int containing one of the enumerated constant values describing image formats from `BufferedImage`. Returns:int an `int` representing a `BufferedImage` type. See Also `java.awt.image.BufferedImage`, `java.awt.image.BufferedImage#TYPE_CUSTOM`, `java.awt.image.BufferedImage#TYPE_INT_RGB`, `java.awt.image.BufferedImage#TYPE_INT_ARGB`, `java.awt.image.BufferedImage#TYPE_INT_ARGB_PRE`, `java.awt.image.BufferedImage#TYPE_INT_BGR`, `java.awt.image.BufferedImage#TYPE_3BYTE_BGR`, `java.awt.image.BufferedImage#TYPE_4BYTE_ABGR`, `java.awt.image.BufferedImage#TYPE_4BYTE_ABGR_PRE`, `java.awt.image.BufferedImage#TYPE_USHORT_565_RGB`, `java.awt.image.BufferedImage#TYPE_USHORT_555_RGB`, `java.awt.image.BufferedImage#TYPE_BYTE_GRAY`, `java.awt.image.BufferedImage#TYPE_USHORT_GRAY`, `java.awt.image.BufferedImage#TYPE_BYTE_BINARY`, `java.awt.image.BufferedImage#TYPE_BYTE_INDEXED`

public int getBufferedImageType()

Returns an int containing one of the enumerated constant values describing image formats from BufferedImage.

Returns:int: an int representing a BufferedImage type.
See Also: java.awt.image.BufferedImage, java.awt.image.BufferedImage#TYPE_CUSTOM, java.awt.image.BufferedImage#TYPE_INT_RGB, java.awt.image.BufferedImage#TYPE_INT_ARGB, java.awt.image.BufferedImage#TYPE_INT_ARGB_PRE, java.awt.image.BufferedImage#TYPE_INT_BGR, java.awt.image.BufferedImage#TYPE_3BYTE_BGR, java.awt.image.BufferedImage#TYPE_4BYTE_ABGR, java.awt.image.BufferedImage#TYPE_4BYTE_ABGR_PRE, java.awt.image.BufferedImage#TYPE_USHORT_565_RGB, java.awt.image.BufferedImage#TYPE_USHORT_555_RGB, java.awt.image.BufferedImage#TYPE_BYTE_GRAY, java.awt.image.BufferedImage#TYPE_USHORT_GRAY, java.awt.image.BufferedImage#TYPE_BYTE_BINARY, java.awt.image.BufferedImage#TYPE_BYTE_INDEXED

getColorModel back to summary

getColorModel	back to summary
public ColorModel getColorModel() Returns the `ColorModel` specified by this object. Returns:ColorModel a `ColorModel`.

public ColorModel getColorModel()

Returns the ColorModel specified by this object.

Returns:ColorModel: a ColorModel.

getNumBands back to summary

getNumBands	back to summary
public int getNumBands() Return the number of bands specified by this object. This is the same value as returned by `SampleModel.getNumBands` Returns:int the number of bands in the image.

public int getNumBands()

Return the number of bands specified by this object. This is the same value as returned by SampleModel.getNumBands

Returns:int: the number of bands in the image.

getNumComponents back to summary

getNumComponents	back to summary
public int getNumComponents() Return the number of color components specified by this object. This is the same value as returned by `ColorModel.getNumComponents` Returns:int the number of components in the image.

public int getNumComponents()

Return the number of color components specified by this object. This is the same value as returned by ColorModel.getNumComponents

Returns:int: the number of components in the image.

getSampleModel back to summary

getSampleModel	back to summary
public SampleModel getSampleModel() Returns a `SampleModel` based on the settings encapsulated within this object. The width and height of the `SampleModel` will be set to arbitrary values. Returns:SampleModel a `SampleModel` with arbitrary dimensions.

public SampleModel getSampleModel()

Returns a SampleModel based on the settings encapsulated within this object. The width and height of the SampleModel will be set to arbitrary values.

Returns:SampleModel: a SampleModel with arbitrary dimensions.

getSampleModel back to summary

getSampleModel	back to summary
public SampleModel getSampleModel(int width, int height) Returns a `SampleModel` based on the settings encapsulated within this object. The width and height of the `SampleModel` will be set to the supplied values. Parameters width:int the desired width of the returned `SampleModel`. height:int the desired height of the returned `SampleModel`. Returns:SampleModel a `SampleModel` with the given dimensions. Exceptions IllegalArgumentException: if either `width` or `height` are negative or zero. if the product of `width` and `height` is greater than `Integer.MAX_VALUE`

public SampleModel getSampleModel(int width, int height)

Returns a SampleModel based on the settings encapsulated within this object. The width and height of the SampleModel will be set to the supplied values.

Parameters

width:int: the desired width of the returned SampleModel.
height:int: the desired height of the returned SampleModel.

Returns:SampleModel

a SampleModel with the given dimensions.

Exceptions

IllegalArgumentException:

if either width or height are negative or zero.
if the product of width and height is greater than Integer.MAX_VALUE

getSpecifier	back to summary
private static ImageTypeSpecifier getSpecifier(int type)

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns the hash code for this ImageTypeSpecifier. Returns:int a hash code for this ImageTypeSpecifier

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns the hash code for this ImageTypeSpecifier.

Returns:int: a hash code for this ImageTypeSpecifier

javax.imageio back to summary

pack-priv Class ImageTypeSpecifier.Banded

Class Inheritance

extends ImageTypeSpecifier

java.lang.Object
javax.imageio.ImageTypeSpecifier
javax.imageio.ImageTypeSpecifier.Banded

Field Summary

Modifier and Type	Field and Description
pack-priv int[]	bandOffsets
pack-priv int[]	bankIndices
pack-priv ColorSpace	colorSpace
pack-priv int	dataType
pack-priv boolean	hasAlpha
pack-priv boolean	isAlphaPremultiplied

Inherited from javax.imageio.ImageTypeSpecifier:: colorModel sampleModel

Constructor Summary

Access	Constructor and Description
public	Banded(ColorSpace colorSpace, int[] bankIndices, int[] bandOffsets, int dataType, boolean hasAlpha, boolean isAlphaPremultiplied)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object o) Overrides javax.imageio.ImageTypeSpecifier.equals. Returns `true` if the given `Object` is an `ImageTypeSpecifier` and has a `SampleModel` and `ColorModel` that are equal to those of this object.
public int	hashCode() Overrides javax.imageio.ImageTypeSpecifier.hashCode. Returns the hash code for this ImageTypeSpecifier.

Inherited from javax.imageio.ImageTypeSpecifier:: createBanded createBufferedImage createComponentCM createFromBufferedImageType createFromRenderedImage createGrayscale createGrayscale createIndexed createInterleaved createPacked getBitsPerBand getBufferedImageType getColorModel getNumBands getNumComponents getSampleModel getSampleModel

Field Detail

bandOffsets	back to summary
pack-priv int[] bandOffsets

bankIndices	back to summary
pack-priv int[] bankIndices

colorSpace	back to summary
pack-priv ColorSpace colorSpace

dataType	back to summary
pack-priv int dataType

hasAlpha	back to summary
pack-priv boolean hasAlpha

isAlphaPremultiplied	back to summary
pack-priv boolean isAlphaPremultiplied

Constructor Detail

Banded	back to summary
public Banded(ColorSpace colorSpace, int[] bankIndices, int[] bandOffsets, int dataType, boolean hasAlpha, boolean isAlphaPremultiplied)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides javax.imageio.ImageTypeSpecifier.equals. Doc from javax.imageio.ImageTypeSpecifier.equals. Returns `true` if the given `Object` is an `ImageTypeSpecifier` and has a `SampleModel` and `ColorModel` that are equal to those of this object.

public boolean equals(Object o)

Overrides javax.imageio.ImageTypeSpecifier.equals.

Doc from javax.imageio.ImageTypeSpecifier.equals.

Returns true if the given Object is an ImageTypeSpecifier and has a SampleModel and ColorModel that are equal to those of this object.

hashCode	back to summary
public int hashCode() Overrides javax.imageio.ImageTypeSpecifier.hashCode. Doc from javax.imageio.ImageTypeSpecifier.hashCode. Returns the hash code for this ImageTypeSpecifier.

hashCode

back to summary

public int hashCode()

Overrides javax.imageio.ImageTypeSpecifier.hashCode.

Doc from javax.imageio.ImageTypeSpecifier.hashCode.

Returns the hash code for this ImageTypeSpecifier.

javax.imageio back to summary

pack-priv Class ImageTypeSpecifier.Grayscale

Class Inheritance

extends ImageTypeSpecifier

java.lang.Object
javax.imageio.ImageTypeSpecifier
javax.imageio.ImageTypeSpecifier.Grayscale

Field Summary

Modifier and Type	Field and Description
pack-priv int	bits
pack-priv int	dataType
pack-priv boolean	hasAlpha
pack-priv boolean	isAlphaPremultiplied
pack-priv boolean	isSigned

Inherited from javax.imageio.ImageTypeSpecifier:: colorModel sampleModel

Constructor Summary

Access	Constructor and Description
public	Grayscale(int bits, int dataType, boolean isSigned, boolean hasAlpha, boolean isAlphaPremultiplied)

Method Summary

Field Detail

bits	back to summary
pack-priv int bits

dataType	back to summary
pack-priv int dataType

hasAlpha	back to summary
pack-priv boolean hasAlpha

isAlphaPremultiplied	back to summary
pack-priv boolean isAlphaPremultiplied

isSigned	back to summary
pack-priv boolean isSigned

Constructor Detail

Grayscale	back to summary
public Grayscale(int bits, int dataType, boolean isSigned, boolean hasAlpha, boolean isAlphaPremultiplied)

javax.imageio back to summary

pack-priv Class ImageTypeSpecifier.Indexed

Class Inheritance

extends ImageTypeSpecifier

java.lang.Object
javax.imageio.ImageTypeSpecifier
javax.imageio.ImageTypeSpecifier.Indexed

Field Summary

Modifier and Type	Field and Description
pack-priv byte[]	alphaLUT
pack-priv int	bits
pack-priv byte[]	blueLUT
pack-priv int	dataType
pack-priv byte[]	greenLUT
pack-priv byte[]	redLUT

Inherited from javax.imageio.ImageTypeSpecifier:: colorModel sampleModel

Constructor Summary

Access	Constructor and Description
public	Indexed(byte[] redLUT, byte[] greenLUT, byte[] blueLUT, byte[] alphaLUT, int bits, int dataType)

Method Summary

Field Detail

alphaLUT	back to summary
pack-priv byte[] alphaLUT

bits	back to summary
pack-priv int bits

blueLUT	back to summary
pack-priv byte[] blueLUT

dataType	back to summary
pack-priv int dataType

greenLUT	back to summary
pack-priv byte[] greenLUT

redLUT	back to summary
pack-priv byte[] redLUT

Constructor Detail

Indexed	back to summary
public Indexed(byte[] redLUT, byte[] greenLUT, byte[] blueLUT, byte[] alphaLUT, int bits, int dataType)

javax.imageio back to summary

pack-priv Class ImageTypeSpecifier.Interleaved

Class Inheritance

extends ImageTypeSpecifier

java.lang.Object
javax.imageio.ImageTypeSpecifier
javax.imageio.ImageTypeSpecifier.Interleaved

Field Summary

Modifier and Type	Field and Description
pack-priv int[]	bandOffsets
pack-priv ColorSpace	colorSpace
pack-priv int	dataType
pack-priv boolean	hasAlpha
pack-priv boolean	isAlphaPremultiplied

Inherited from javax.imageio.ImageTypeSpecifier:: colorModel sampleModel

Constructor Summary

Access	Constructor and Description
public	Interleaved(ColorSpace colorSpace, int[] bandOffsets, int dataType, boolean hasAlpha, boolean isAlphaPremultiplied)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object o) Overrides javax.imageio.ImageTypeSpecifier.equals. Returns `true` if the given `Object` is an `ImageTypeSpecifier` and has a `SampleModel` and `ColorModel` that are equal to those of this object.
public int	hashCode() Overrides javax.imageio.ImageTypeSpecifier.hashCode. Returns the hash code for this ImageTypeSpecifier.

Inherited from javax.imageio.ImageTypeSpecifier:: createBanded createBufferedImage createComponentCM createFromBufferedImageType createFromRenderedImage createGrayscale createGrayscale createIndexed createInterleaved createPacked getBitsPerBand getBufferedImageType getColorModel getNumBands getNumComponents getSampleModel getSampleModel

Field Detail

bandOffsets	back to summary
pack-priv int[] bandOffsets

colorSpace	back to summary
pack-priv ColorSpace colorSpace

dataType	back to summary
pack-priv int dataType

hasAlpha	back to summary
pack-priv boolean hasAlpha

isAlphaPremultiplied	back to summary
pack-priv boolean isAlphaPremultiplied

Constructor Detail

Interleaved	back to summary
public Interleaved(ColorSpace colorSpace, int[] bandOffsets, int dataType, boolean hasAlpha, boolean isAlphaPremultiplied)

Method Detail

equals back to summary

public boolean equals(Object o)

Overrides javax.imageio.ImageTypeSpecifier.equals.

Doc from javax.imageio.ImageTypeSpecifier.equals.

Returns true if the given Object is an ImageTypeSpecifier and has a SampleModel and ColorModel that are equal to those of this object.

hashCode

back to summary

public int hashCode()

Overrides javax.imageio.ImageTypeSpecifier.hashCode.

Doc from javax.imageio.ImageTypeSpecifier.hashCode.

Returns the hash code for this ImageTypeSpecifier.

javax.imageio back to summary

pack-priv Class ImageTypeSpecifier.Packed

Class Inheritance

extends ImageTypeSpecifier

java.lang.Object
javax.imageio.ImageTypeSpecifier
javax.imageio.ImageTypeSpecifier.Packed

Field Summary

Modifier and Type	Field and Description
pack-priv int	alphaMask
pack-priv int	blueMask
pack-priv ColorSpace	colorSpace
pack-priv int	greenMask
pack-priv boolean	isAlphaPremultiplied
pack-priv int	redMask
pack-priv int	transferType

Inherited from javax.imageio.ImageTypeSpecifier:: colorModel sampleModel

Constructor Summary

Access	Constructor and Description
public	Packed(ColorSpace colorSpace, int redMask, int greenMask, int blueMask, int alphaMask, int transferType, boolean isAlphaPremultiplied)

Method Summary

Field Detail

alphaMask	back to summary
pack-priv int alphaMask

blueMask	back to summary
pack-priv int blueMask

colorSpace	back to summary
pack-priv ColorSpace colorSpace

greenMask	back to summary
pack-priv int greenMask

isAlphaPremultiplied	back to summary
pack-priv boolean isAlphaPremultiplied

redMask	back to summary
pack-priv int redMask

transferType	back to summary
pack-priv int transferType

Constructor Detail

Packed	back to summary
public Packed(ColorSpace colorSpace, int redMask, int greenMask, int blueMask, int alphaMask, int transferType, boolean isAlphaPremultiplied)

public Class ImageTypeSpecifier

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class ImageTypeSpecifier.Banded

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class ImageTypeSpecifier.Grayscale

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

pack-priv Class ImageTypeSpecifier.Indexed

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

pack-priv Class ImageTypeSpecifier.Interleaved

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class ImageTypeSpecifier.Packed

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail