Class AbstractImageIOEncoder

java.lang.Object

is.galia.codec.AbstractImageIOEncoder

Direct Known Subclasses:

GIFEncoder, JPEGEncoder, PNGEncoder, TIFFEncoder

public abstract class AbstractImageIOEncoder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected Arena	arena
protected Encode	encode
protected ImageWriter	iioWriter

Constructor Summary

Constructors

Constructor	Description
AbstractImageIOEncoder()

Method Summary

Modifier and Type	Method	Description
protected abstract void	addMetadata(IIOMetadataNode baseTree)	Embeds metadata from encode into the given tree.
void	close()	Should be called when the instance is no longer needed.
protected abstract org.slf4j.Logger	getLogger()
protected IIOMetadata	getMetadata(ImageWriteParam writeParam, RenderedImage image)
protected abstract String[]	getPreferredIIOImplementations()	N.B.: This method returns a list of strings rather than classes because some readers reside under the com.sun package, which is encapsulated in Java 9.
void	setArena(Arena arena)
void	setEncode(Encode encode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

arena

protected Arena arena

iioWriter

protected ImageWriter iioWriter

encode

protected Encode encode

Constructor Details

AbstractImageIOEncoder

public AbstractImageIOEncoder()

Method Details

addMetadata

protected abstract void addMetadata(IIOMetadataNode baseTree)
                             throws IOException

Embeds metadata from encode into the given tree.

Writers for formats that don't support metadata may simply do nothing.

Parameters:

baseTree - Tree to embed the metadata into.

Throws:

IOException

close

public void close()

Should be called when the instance is no longer needed.

getLogger

protected abstract org.slf4j.Logger getLogger()

getMetadata

protected IIOMetadata getMetadata(ImageWriteParam writeParam,
 RenderedImage image)
                           throws IOException

Parameters:

writeParam - Write parameters on which to base the metadata.

image - Image to apply the metadata to.

Returns:

Image metadata with added metadata corresponding to any writer-specific operations applied.

Throws:

IOException

getPreferredIIOImplementations

protected abstract String[] getPreferredIIOImplementations()

N.B.: This method returns a list of strings rather than classes because some readers reside under the com.sun package, which is encapsulated in Java 9.

Returns:

Plugins preferred by the application, in order of most to least preferred, or an empty array if there is no preference.

setArena

public void setArena(Arena arena)

setEncode

public void setEncode(Encode encode)