OpenJDK 1.23 · com.sun.imageio.plugins.common.ImageUtil

Access	Constructor and Description
public	ImageUtil()

Method Summary

Modifier and Type	Method and Description
public static final void	canEncodeImage(ImageWriter The provided `ImageWriter`. writer, ImageTypeSpecifier The image to be tested. type) Checks that the provided `ImageWriter` can encode the provided `ImageTypeSpecifier` or not.
public static final void	canEncodeImage(ImageWriter The provided `ImageWriter`. writer, ColorModel The provided `ColorModel`. colorModel, SampleModel The provided `SampleModel`. sampleModel) Checks that the provided `ImageWriter` can encode the provided `ColorModel` and `SampleModel`.
public static String	convertObjectToString(Object obj) Converts the provided object to `String`
public static final ColorModel	Returns: An instance of `ColorModel` that is suitable for the supplied `SampleModel`, or `null`. createColorModel(SampleModel sampleModel) Creates a `ColorModel` that may be used with the specified `SampleModel`.
public static ColorModel	createColorModel(ColorSpace colorSpace, SampleModel sampleModel)
public static long	getBandSize(SampleModel sm)
public static final ImageTypeSpecifier	getDestinationType(ImageReadParam param, Iterator<ImageTypeSpecifier> imageTypes) Gets the destination image type.
public static int	getElementSize(SampleModel sm)
public static byte[]	Returns: the binary data as a packed array of bytes with zero offset of `null` if the data are not binary. getPackedBinaryData(Raster raster, Rectangle rect) For the case of binary data (`isBinary()` returns `true`), return the binary data as a packed byte array.
public static long	getTileSize(SampleModel sm)
public static byte[]	getUnpackedBinaryData(Raster raster, Rectangle rect) Returns the binary data unpacked into an array of bytes.
public static final boolean	imageIsContiguous(RenderedImage image) Returns whether the image has contiguous data across rows.
public static boolean	isBinary(SampleModel sm)
public static boolean	Returns: If all the indices have 256 entries, and are identical mappings, return `true`; otherwise, return `false`. isIndicesForGrayscale(byte[] The red channel color indices. r, byte[] The green channel color indices. g, byte[] The blue channel color indices. b) Tests whether the color indices represent a gray-scale image.
public static boolean	isNonStandardICCColorSpace(ColorSpace the `ColorSpace` to test cs) Returns `true` if the given `ColorSpace` object is an instance of `ICC_ColorSpace` but is not one of the standard `ColorSpace`s returned by `ColorSpace.getInstance()`.
public static void	setPackedBinaryData(byte[] binaryDataArray, WritableRaster raster, Rectangle rect) Sets the supplied `Raster`'s data from an array of packed binary data of the form returned by `getPackedBinaryData()`.
public static void	setUnpackedBinaryData(byte[] bdata, WritableRaster raster, Rectangle rect) Copies data into the packed array of the `Raster` from an array of unpacked data of the form returned by `getUnpackedBinaryData()`.

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

ImageUtil	back to summary
public ImageUtil()

Method Detail

canEncodeImage back to summary

canEncodeImage	back to summary
public static final void canEncodeImage(ImageWriter writer, ImageTypeSpecifier type) throws IIOException Checks that the provided `ImageWriter` can encode the provided `ImageTypeSpecifier` or not. If not, an `IIOException` will be thrown. Parameters writer:ImageWriter The provided `ImageWriter`. type:ImageTypeSpecifier The image to be tested. Exceptions IIOException: If the writer cannot encoded the provided image.

public static final void canEncodeImage(ImageWriter writer, ImageTypeSpecifier type) throws IIOException

Checks that the provided ImageWriter can encode the provided ImageTypeSpecifier or not. If not, an IIOException will be thrown.

Parameters

writer:ImageWriter: The provided ImageWriter.
type:ImageTypeSpecifier: The image to be tested.

Exceptions

IIOException:: If the writer cannot encoded the provided image.

canEncodeImage back to summary

canEncodeImage	back to summary
public static final void canEncodeImage(ImageWriter writer, ColorModel colorModel, SampleModel sampleModel) throws IIOException Checks that the provided `ImageWriter` can encode the provided `ColorModel` and `SampleModel`. If not, an `IIOException` will be thrown. Parameters writer:ImageWriter The provided `ImageWriter`. colorModel:ColorModel The provided `ColorModel`. sampleModel:SampleModel The provided `SampleModel`. Exceptions IIOException: If the writer cannot encoded the provided image.

public static final void canEncodeImage(ImageWriter writer, ColorModel colorModel, SampleModel sampleModel) throws IIOException

Checks that the provided ImageWriter can encode the provided ColorModel and SampleModel. If not, an IIOException will be thrown.

Parameters

writer:ImageWriter: The provided ImageWriter.
colorModel:ColorModel: The provided ColorModel.
sampleModel:SampleModel: The provided SampleModel.

Exceptions

IIOException:: If the writer cannot encoded the provided image.

convertObjectToString	back to summary
public static String convertObjectToString(Object obj) Converts the provided object to `String`

createColorModel back to summary

createColorModel	back to summary
public static final ColorModel createColorModel(SampleModel sampleModel) Creates a `ColorModel` that may be used with the specified `SampleModel`. If a suitable `ColorModel` cannot be found, this method returns `null`. Suitable `ColorModel`s are guaranteed to exist for all instances of `ComponentSampleModel`. For 1- and 3- banded `SampleModel`s, the returned `ColorModel` will be opaque. For 2- and 4-banded `SampleModel`s, the output will use alpha transparency which is not premultiplied. 1- and 2-banded data will use a grayscale `ColorSpace`, and 3- and 4-banded data a sRGB `ColorSpace`. Data with 5 or more bands will have a `BogusColorSpace`. An instance of `DirectColorModel` will be created for instances of `SinglePixelPackedSampleModel` with no more than 4 bands. An instance of `IndexColorModel` will be created for instances of `MultiPixelPackedSampleModel`. The colormap will be a grayscale ramp with `1 << numberOfBits` entries ranging from zero to at most 255. Returns:ColorModel An instance of `ColorModel` that is suitable for the supplied `SampleModel`, or `null`. Exceptions IllegalArgumentException: If `sampleModel` is `null`.

public static final ColorModel createColorModel(SampleModel sampleModel)

Creates a ColorModel that may be used with the specified SampleModel. If a suitable ColorModel cannot be found, this method returns null.

Suitable ColorModels are guaranteed to exist for all instances of ComponentSampleModel. For 1- and 3- banded SampleModels, the returned ColorModel will be opaque. For 2- and 4-banded SampleModels, the output will use alpha transparency which is not premultiplied. 1- and 2-banded data will use a grayscale ColorSpace, and 3- and 4-banded data a sRGB ColorSpace. Data with 5 or more bands will have a BogusColorSpace.

An instance of DirectColorModel will be created for instances of SinglePixelPackedSampleModel with no more than 4 bands.

An instance of IndexColorModel will be created for instances of MultiPixelPackedSampleModel. The colormap will be a grayscale ramp with 1 << numberOfBits entries ranging from zero to at most 255.

Returns:ColorModel

An instance of ColorModel that is suitable for the supplied SampleModel, or null.

Exceptions

IllegalArgumentException:: If sampleModel is null.

createColorModel	back to summary
public static ColorModel createColorModel(ColorSpace colorSpace, SampleModel sampleModel)

getBandSize	back to summary
public static long getBandSize(SampleModel sm)

getDestinationType	back to summary
public static final ImageTypeSpecifier getDestinationType(ImageReadParam param, Iterator<ImageTypeSpecifier> imageTypes) throws IIOException Gets the destination image type.

getElementSize	back to summary
public static int getElementSize(SampleModel sm)

getPackedBinaryData back to summary

getPackedBinaryData	back to summary
public static byte[] getPackedBinaryData(Raster raster, Rectangle rect) For the case of binary data (`isBinary()` returns `true`), return the binary data as a packed byte array. The data will be packed as eight bits per byte with no bit offset, i.e., the first bit in each image line will be the left-most of the first byte of the line. The line stride in bytes will be `(int)((getWidth()+7)/8)`. The length of the returned array will be the line stride multiplied by `getHeight()` Returns:byte[] the binary data as a packed array of bytes with zero offset of `null` if the data are not binary. Exceptions IllegalArgumentException: if `isBinary()` returns `false` with the `SampleModel` of the supplied `Raster` as argument.

public static byte[] getPackedBinaryData(Raster raster, Rectangle rect)

For the case of binary data (isBinary() returns true), return the binary data as a packed byte array. The data will be packed as eight bits per byte with no bit offset, i.e., the first bit in each image line will be the left-most of the first byte of the line. The line stride in bytes will be (int)((getWidth()+7)/8). The length of the returned array will be the line stride multiplied by getHeight()

Returns:byte[]

the binary data as a packed array of bytes with zero offset of null if the data are not binary.

Exceptions

IllegalArgumentException:: if isBinary() returns false with the SampleModel of the supplied Raster as argument.

getTileSize	back to summary
public static long getTileSize(SampleModel sm)

getUnpackedBinaryData back to summary

getUnpackedBinaryData	back to summary
public static byte[] getUnpackedBinaryData(Raster raster, Rectangle rect) Returns the binary data unpacked into an array of bytes. The line stride will be the width of the `Raster`. Exceptions IllegalArgumentException: if `isBinary()` returns `false` with the `SampleModel` of the supplied `Raster` as argument.

public static byte[] getUnpackedBinaryData(Raster raster, Rectangle rect)

Returns the binary data unpacked into an array of bytes. The line stride will be the width of the Raster.

Exceptions

IllegalArgumentException:: if isBinary() returns false with the SampleModel of the supplied Raster as argument.

imageIsContiguous	back to summary
public static final boolean imageIsContiguous(RenderedImage image) Returns whether the image has contiguous data across rows.

isBinary	back to summary
public static boolean isBinary(SampleModel sm)

isIndicesForGrayscale back to summary

isIndicesForGrayscale	back to summary
public static boolean isIndicesForGrayscale(byte[] r, byte[] g, byte[] b) Tests whether the color indices represent a gray-scale image. Parameters r:byte[] The red channel color indices. g:byte[] The green channel color indices. b:byte[] The blue channel color indices. Returns:boolean If all the indices have 256 entries, and are identical mappings, return `true`; otherwise, return `false`.

public static boolean isIndicesForGrayscale(byte[] r, byte[] g, byte[] b)

Tests whether the color indices represent a gray-scale image.

Parameters

r:byte[]: The red channel color indices.
g:byte[]: The green channel color indices.
b:byte[]: The blue channel color indices.

Returns:boolean

If all the indices have 256 entries, and are identical mappings, return true; otherwise, return false.

isNonStandardICCColorSpace back to summary

isNonStandardICCColorSpace	back to summary
public static boolean isNonStandardICCColorSpace(ColorSpace cs) Returns `true` if the given `ColorSpace` object is an instance of `ICC_ColorSpace` but is not one of the standard `ColorSpace`s returned by `ColorSpace.getInstance()`. Parameters cs:ColorSpace the `ColorSpace` to test

public static boolean isNonStandardICCColorSpace(ColorSpace cs)

Returns true if the given ColorSpace object is an instance of ICC_ColorSpace but is not one of the standard ColorSpaces returned by ColorSpace.getInstance().

Parameters

cs:ColorSpace: the ColorSpace to test

setPackedBinaryData back to summary

setPackedBinaryData	back to summary
public static void setPackedBinaryData(byte[] binaryDataArray, WritableRaster raster, Rectangle rect) Sets the supplied `Raster`'s data from an array of packed binary data of the form returned by `getPackedBinaryData()`. Exceptions IllegalArgumentException: if `isBinary()` returns `false` with the `SampleModel` of the supplied `Raster` as argument.

public static void setPackedBinaryData(byte[] binaryDataArray, WritableRaster raster, Rectangle rect)

Sets the supplied Raster's data from an array of packed binary data of the form returned by getPackedBinaryData().

Exceptions

IllegalArgumentException:: if isBinary() returns false with the SampleModel of the supplied Raster as argument.

setUnpackedBinaryData back to summary

setUnpackedBinaryData	back to summary
public static void setUnpackedBinaryData(byte[] bdata, WritableRaster raster, Rectangle rect) Copies data into the packed array of the `Raster` from an array of unpacked data of the form returned by `getUnpackedBinaryData()`. If the data are binary, then the target bit will be set if and only if the corresponding byte is non-zero. Exceptions IllegalArgumentException: if `isBinary()` returns `false` with the `SampleModel` of the supplied `Raster` as argument.

public static void setUnpackedBinaryData(byte[] bdata, WritableRaster raster, Rectangle rect)

Copies data into the packed array of the Raster from an array of unpacked data of the form returned by getUnpackedBinaryData().

If the data are binary, then the target bit will be set if and only if the corresponding byte is non-zero.

Exceptions

IllegalArgumentException:: if isBinary() returns false with the SampleModel of the supplied Raster as argument.

public Class ImageUtil

Constructor Summary

Method Summary

Constructor Detail

Method Detail