OpenJDK 27 · com.sun.imageio.plugins.tiff.TIFFImageWriter

Field Summary

Modifier and Type	Field and Description
private int	bitDepth
private char[]	bitsPerSample
private ByteOrder	byteOrder
private TIFFColorConverter	colorConverter
private int	compression
pack-priv static final int[]	compressionNumbers Compression tag values for known compression types.
pack-priv static final String[]	compressionTypes Known TIFF compression types.
private TIFFCompressor	compressor
private int	currentImage
private static final int	DEFAULT_BYTES_PER_STRIP
pack-priv static final String	EXIF_JPEG_COMPRESSION_TYPE
private long	headerPosition
private RenderedImage	image
private TIFFImageMetadata	imageMetadata
private ImageTypeSpecifier	imageType
private boolean	inReplacePixelsNest
private boolean	isBilevel
pack-priv static final boolean[]	isCompressionLossless Lossless flag for known compression types.
private boolean	isImageSimple
private boolean	isInsertingEmpty
private boolean	isInverted
private boolean	isRescaling
private boolean	isTiled
private boolean	isWritingEmpty
private boolean	isWritingSequence
private int	nativePhotometricInterpretation
private long	nextIFDPointerPos
private long	nextSpace
private int	numBands
private ImageWriteParam	param
private int	periodX
private int	periodY
private int	photometricInterpretation
private int	pixelsDone
private int	predictor
private long	prevHeaderPosition
private long	prevNextSpace
private long	prevStreamPosition
private TIFFImageReader	reader
private long[]	replacePixelsByteCounts
private long	replacePixelsByteCountsPosition
private int	replacePixelsIndex
private Object	replacePixelsLock
private TIFFImageMetadata	replacePixelsMetadata
private long	replacePixelsOffsetsPosition
private Rectangle	replacePixelsRegion
private long[]	replacePixelsTileOffsets
private int	sampleFormat
private int[]	sampleSize
private byte[][]	scale
private byte[]	scale0
private byte[][]	scaleh
private byte[][]	scalel
private int	scalingBitDepth
private int[]	sourceBands
private int	sourceHeight
private int	sourceWidth
private int	sourceXOffset
private int	sourceYOffset
private ImageOutputStream	stream
private TIFFStreamMetadata	streamMetadata
pack-priv static final String[]	TIFFCompressionTypes Supported TIFF compression types.
private int	tileLength
private int	tilesAcross
private int	tilesDown
private int	tileWidth
private int	totalPixels

Inherited from javax.imageio.ImageWriter:: availableLocales locale originatingProvider output progressListeners warningListeners warningLocales

Access	Constructor and Description
public	TIFFImageWriter(ImageWriterSpi originatingProvider)

Method Summary

Modifier and Type	Method and Description
public boolean	canInsertEmpty(int imageIndex) Overrides javax.imageio.ImageWriter.canInsertEmpty. Returns `true` if the writer supports the insertion of a new, empty image at the given index.
public boolean	canInsertImage(int imageIndex) Overrides javax.imageio.ImageWriter.canInsertImage. Returns `true` if the writer supports the insertion of a new image at the given index.
public boolean	canReplacePixels(int imageIndex) Overrides javax.imageio.ImageWriter.canReplacePixels. Returns `true` if the writer allows pixels of the given image to be replaced using the `replacePixels` methods.
public boolean	canWriteEmpty() Overrides javax.imageio.ImageWriter.canWriteEmpty. Returns `true` if the writer supports the writing of a complete image stream consisting of a single image with undefined pixel values and associated metadata and thumbnails to the output.
public boolean	canWriteSequence() Overrides javax.imageio.ImageWriter.canWriteSequence. Returns `true` if the writer is able to append an image to an image stream that already contains header information and possibly prior images.
private void	checkParamsEmpty(ImageTypeSpecifier imageType, int width, int height, List<? extends BufferedImage> thumbnails)
public IIOMetadata	convertImageMetadata(IIOMetadata inData, ImageTypeSpecifier imageType, ImageWriteParam param) Implements abstract javax.imageio.ImageWriter.convertImageMetadata. Implements javax.imageio.ImageTranscoder.convertImageMetadata. Returns an `IIOMetadata` object that may be used for encoding and optionally modified using its document interfaces or other interfaces specific to the writer plug-in that will be used for encoding.
private TIFFImageMetadata	Returns: a `TIFFImageMetadata` or `null` if the native tree derived from the input object is `null`. convertNativeImageMetadata(IIOMetadata The metadata object. inData) Converts a native `javax_imageio_tiff_image_1.0` tree to a `TIFFImageMetadata` object.
private TIFFImageMetadata	Returns: a `TIFFImageMetadata` or `null` if the standard tree derived from the input object is `null`. convertStandardImageMetadata(IIOMetadata The metadata object. inData) Converts a standard `javax_imageio_1.0` tree to a `TIFFImageMetadata` object.
public IIOMetadata	convertStreamMetadata(IIOMetadata inData, ImageWriteParam param) Implements abstract javax.imageio.ImageWriter.convertStreamMetadata. Implements javax.imageio.ImageTranscoder.convertStreamMetadata. Returns an `IIOMetadata` object that may be used for encoding and optionally modified using its document interfaces or other interfaces specific to the writer plug-in that will be used for encoding.
public void	endInsertEmpty() Overrides javax.imageio.ImageWriter.endInsertEmpty. Completes the insertion of a new image that was begun with a prior call to `prepareInsertEmpty`.
public void	endReplacePixels() Overrides javax.imageio.ImageWriter.endReplacePixels. Terminates a sequence of calls to `replacePixels`.
public void	endWriteEmpty() Overrides javax.imageio.ImageWriter.endWriteEmpty. Completes the writing of a new image that was begun with a prior call to `prepareWriteEmpty`.
public void	endWriteSequence() Overrides javax.imageio.ImageWriter.endWriteSequence. Completes the writing of a sequence of images begun with `prepareWriteSequence`.
private boolean	equals(int[] s0, int[] s1)
public IIOMetadata	getDefaultImageMetadata(ImageTypeSpecifier imageType, ImageWriteParam param) Implements abstract javax.imageio.ImageWriter.getDefaultImageMetadata. Returns an `IIOMetadata` object containing default values for encoding an image of the given type.
public IIOMetadata	getDefaultStreamMetadata(ImageWriteParam param) Implements abstract javax.imageio.ImageWriter.getDefaultStreamMetadata. Returns an `IIOMetadata` object containing default values for encoding a stream of images.
public ImageWriteParam	getDefaultWriteParam() Overrides javax.imageio.ImageWriter.getDefaultWriteParam. Returns a new `ImageWriteParam` object of the appropriate type for this file format containing default values, that is, those values that would be used if no `ImageWriteParam` object were specified.
pack-priv ImageTypeSpecifier	getImageType()
private void	initializeScaleTables(int[] sampleSize)
private void	insert(int imageIndex, IIOImage image, ImageWriteParam param, boolean writeData)
private boolean	isEncodingEmpty()
private void	locateIFD(int imageIndex, long[] ifdpos, long[] ifd)
private void	markPositions()
public void	prepareInsertEmpty(int imageIndex, ImageTypeSpecifier imageType, int width, int height, IIOMetadata imageMetadata, List<? extends BufferedImage> thumbnails, ImageWriteParam param) Overrides javax.imageio.ImageWriter.prepareInsertEmpty. Begins the insertion of a new image with undefined pixel values into an existing image stream.
public void	prepareReplacePixels(int imageIndex, Rectangle region) Overrides javax.imageio.ImageWriter.prepareReplacePixels. Prepares the writer to handle a series of calls to the `replacePixels` methods.
public void	prepareWriteEmpty(IIOMetadata streamMetadata, ImageTypeSpecifier imageType, int width, int height, IIOMetadata imageMetadata, List<? extends BufferedImage> thumbnails, ImageWriteParam param) Overrides javax.imageio.ImageWriter.prepareWriteEmpty. Begins the writing of a complete image stream, consisting of a single image with undefined pixel values and associated metadata and thumbnails, to the output.
public void	prepareWriteSequence(IIOMetadata streamMetadata) Overrides javax.imageio.ImageWriter.prepareWriteSequence. Prepares a stream to accept a series of subsequent `writeToSequence` calls, using the provided stream metadata object.
private TIFFIFD	readIFD(int imageIndex)
public void	replacePixels(RenderedImage image, ImageWriteParam param) Overrides javax.imageio.ImageWriter.replacePixels. Replaces a portion of an image already present in the output with a portion of the given image.
public void	replacePixels(Raster raster, ImageWriteParam param) Overrides javax.imageio.ImageWriter.replacePixels. Replaces a portion of an image already present in the output with a portion of the given `Raster`.
public void	reset() Overrides javax.imageio.ImageWriter.reset. Restores the `ImageWriter` to its initial state.
private void	resetPositions()
public void	setOutput(Object output) Overrides javax.imageio.ImageWriter.setOutput. Sets the destination to the given `ImageOutputStream` or other `Object`.
pack-priv void	setupMetadata(ColorModel The `ColorModel` of the image being written. cm, SampleModel The `SampleModel` of the image being written. sm, int The width of the written image after subsampling. destWidth, int The height of the written image after subsampling. destHeight) Sets up the output metadata adding, removing, and overriding fields as needed.
private Raster	subsample(Raster raster, int[] sourceBands, int subOriginX, int subOriginY, int subPeriodX, int subPeriodY, int dstOffsetX, int dstOffsetY, Rectangle target)
public void	write(IIOMetadata sm, IIOImage iioimage, ImageWriteParam p) Implements abstract javax.imageio.ImageWriter.write. Appends a complete image stream containing a single image and associated stream and image metadata and thumbnails to the output.
private void	write(IIOMetadata sm, IIOImage iioimage, ImageWriteParam p, boolean writeHeader, boolean writeData)
private void	writeHeader()
public void	writeInsert(int imageIndex, IIOImage image, ImageWriteParam param) Overrides javax.imageio.ImageWriter.writeInsert. Inserts a new image into an existing image stream.
private int	writeTile(Rectangle The area to be written which might be outside the image. tileRect, TIFFCompressor compressor)
public void	writeToSequence(IIOImage image, ImageWriteParam param) Overrides javax.imageio.ImageWriter.writeToSequence. Appends a single image and possibly associated metadata and thumbnails, to the output.
public static int	XToTileX(int x, int tileGridXOffset, int tileWidth) Converts a pixel's X coordinate into a horizontal tile index relative to a given tile grid layout specified by its X offset and tile width.
public static int	YToTileY(int y, int tileGridYOffset, int tileHeight) Converts a pixel's Y coordinate into a vertical tile index relative to a given tile grid layout specified by its Y offset and tile height.

public Class TIFFImageWriter

Field Summary

Constructor Summary

Method Summary