Class ImageTranscoderSpi

java.lang.Object

javax.imageio.spi.IIOServiceProvider

javax.imageio.spi.ImageTranscoderSpi

All Implemented Interfaces:

RegisterableService

public abstract class ImageTranscoderSpi
extends IIOServiceProvider

The service provider interface (SPI) for ImageTranscoders. For more information on service provider classes, see the class comment for the IIORegistry class.

See Also:

• IIORegistry
• ImageTranscoder

Field Summary

Fields declared in class IIOServiceProvider

vendorName, version

Modifier and Type	Field	Description
protected String	vendorName	A String to be returned from getVendorName, initially null.
protected String	version	A String to be returned from getVersion, initially null.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ImageTranscoderSpi()	Constructs a blank ImageTranscoderSpi.
	ImageTranscoderSpi(String vendorName, String version)	Constructs an ImageTranscoderSpi with a given set of values.

Method Summary

Modifier and Type	Method	Description
abstract ImageTranscoder	createTranscoderInstance()	Returns an instance of the ImageTranscoder implementation associated with this service provider.
abstract String	getReaderServiceProviderName()	Returns the fully qualified class name of an ImageReaderSpi class that generates IIOMetadata objects that may be used as input to this transcoder.
abstract String	getWriterServiceProviderName()	Returns the fully qualified class name of an ImageWriterSpi class that generates IIOMetadata objects that may be used as input to this transcoder.

Methods declared in class IIOServiceProvider

getDescription, getVendorName, getVersion, onDeregistration, onRegistration

Modifier and Type	Method	Description
abstract String	getDescription(Locale locale)	Returns a brief, human-readable description of this service provider and its associated implementation.
String	getVendorName()	Returns the name of the vendor responsible for creating this service provider and its associated implementation.
String	getVersion()	Returns a string describing the version number of this service provider and its associated implementation.
void	onDeregistration(ServiceRegistry registry, Class<?> category)	A callback that will be whenever the Spi class has been deregistered from a ServiceRegistry.
void	onRegistration(ServiceRegistry registry, Class<?> category)	A callback that will be called exactly once after the Spi class has been instantiated and registered in a ServiceRegistry.

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Constructor Details

ImageTranscoderSpi

protected ImageTranscoderSpi()

Constructs a blank ImageTranscoderSpi. It is up to the subclass to initialize instance variables and/or override method implementations in order to provide working versions of all methods.

ImageTranscoderSpi

public ImageTranscoderSpi(String vendorName,
 String version)

Constructs an ImageTranscoderSpi with a given set of values.

Parameters:

vendorName - the vendor name.

version - a version identifier.

Method Details

getReaderServiceProviderName

public abstract String getReaderServiceProviderName()

Returns the fully qualified class name of an ImageReaderSpi class that generates IIOMetadata objects that may be used as input to this transcoder.

Returns:

a String containing the fully-qualified class name of the ImageReaderSpi implementation class.

See Also:

• ImageReaderSpi

getWriterServiceProviderName

public abstract String getWriterServiceProviderName()

Returns the fully qualified class name of an ImageWriterSpi class that generates IIOMetadata objects that may be used as input to this transcoder.

Returns:

a String containing the fully-qualified class name of the ImageWriterSpi implementation class.

See Also:

• ImageWriterSpi

createTranscoderInstance

public abstract ImageTranscoder createTranscoderInstance()

Returns an instance of the ImageTranscoder implementation associated with this service provider.

Returns:

an ImageTranscoder instance.