Top Fields Constructors Methods
com.sun.imageio.plugins.tiff

public Class TIFFImageReaderSpi

extends ImageReaderSpi
Class Inheritance
Imports
java.io.IOException, java.util.Locale, javax.imageio.ImageReader, javax.imageio.spi.ImageReaderSpi, .ServiceRegistry, javax.imageio.stream.ImageInputStream, com.sun.imageio.plugins.common.ReaderUtil

Field Summary

Modifier and TypeField and Description
private boolean
Inherited from javax.imageio.spi.ImageReaderSpi:
inputTypesSTANDARD_INPUT_TYPEwriterSpiNames

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public boolean
canDecodeInput(Object
the object (typically an ImageInputStream) to be decoded.
input
)

Implements abstract javax.imageio.spi.ImageReaderSpi.canDecodeInput.

Returns true if the supplied source object appears to be of the format supported by this reader.

public ImageReader
createReaderInstance(Object
a plug-in specific extension object, which may be null.
extension
)

Implements abstract javax.imageio.spi.ImageReaderSpi.createReaderInstance.

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

public String
getDescription(Locale
a Locale for which the return value should be localized.
locale
)

Implements abstract javax.imageio.spi.IIOServiceProvider.getDescription.

Returns a brief, human-readable description of this service provider and its associated implementation.

public void
onRegistration(ServiceRegistry
a ServiceRegistry where this object has been registered.
registry
,
Class<?>
a Class object indicating the registry category under which this object has been registered.
category
)

Overrides javax.imageio.spi.IIOServiceProvider.onRegistration.

Implements javax.imageio.spi.RegisterableService.onRegistration.

A callback that will be called exactly once after the Spi class has been instantiated and registered in a ServiceRegistry.

Inherited from javax.imageio.spi.ImageReaderSpi:
createReaderInstancegetImageWriterSpiNamesgetInputTypesisOwnReader

Field Detail

registeredback to summary
private boolean registered

Constructor Detail

TIFFImageReaderSpiback to summary
public TIFFImageReaderSpi()

Method Detail

canDecodeInputback to summary
public boolean canDecodeInput(Object input) throws IOException

Implements abstract javax.imageio.spi.ImageReaderSpi.canDecodeInput.

Doc from javax.imageio.spi.ImageReaderSpi.canDecodeInput.

Returns true if the supplied source object appears to be of the format supported by this reader. Returning true from this method does not guarantee that reading will succeed, only that there appears to be a reasonable chance of success based on a brief inspection of the stream contents. If the source is an ImageInputStream, implementations will commonly check the first several bytes of the stream for a "magic number" associated with the format. Once actual reading has commenced, the reader may still indicate failure at any time prior to the completion of decoding.

It is important that the state of the object not be disturbed in order that other ImageReaderSpis can properly determine whether they are able to decode the object. In particular, if the source is an ImageInputStream, a mark/reset pair should be used to preserve the stream position.

Formats such as "raw," which can potentially attempt to read nearly any stream, should return false in order to avoid being invoked in preference to a closer match.

If source is not an instance of one of the classes returned by getInputTypes, the method should simply return false.

Parameters
input:Object

the object (typically an ImageInputStream) to be decoded.

Returns:boolean

true if it is likely that this stream can be decoded.

Exceptions
IOException:
if an I/O error occurs while reading the stream.
createReaderInstanceback to summary
public ImageReader createReaderInstance(Object extension)

Implements abstract javax.imageio.spi.ImageReaderSpi.createReaderInstance.

Doc from javax.imageio.spi.ImageReaderSpi.createReaderInstance.

Returns an instance of the ImageReader implementation associated with this service provider. The returned object will initially be in an initial state as if its reset method had been called.

An Object may be supplied to the plug-in at construction time. The nature of the object is entirely plug-in specific.

Typically, a plug-in will implement this method using code such as return new MyImageReader(this).

Parameters
extension:Object

a plug-in specific extension object, which may be null.

Returns:ImageReader

an ImageReader instance.

getDescriptionback to summary
public String getDescription(Locale locale)

Implements abstract javax.imageio.spi.IIOServiceProvider.getDescription.

Doc from javax.imageio.spi.IIOServiceProvider.getDescription.

Returns a brief, human-readable description of this service provider and its associated implementation. The resulting string should be localized for the supplied Locale, if possible.

Parameters
locale:Locale

a Locale for which the return value should be localized.

Returns:String

a String containing a description of this service provider.

onRegistrationback to summary
public void onRegistration(ServiceRegistry registry, Class<?> category)

Overrides javax.imageio.spi.IIOServiceProvider.onRegistration.

Implements javax.imageio.spi.RegisterableService.onRegistration.

Doc from javax.imageio.spi.IIOServiceProvider.onRegistration.

A callback that will be called exactly once after the Spi class has been instantiated and registered in a ServiceRegistry. This may be used to verify that the environment is suitable for this service, for example that native libraries can be loaded. If the service cannot function in the environment where it finds itself, it should deregister itself from the registry.

Only the registry should call this method.

The default implementation does nothing.

Parameters
registry:ServiceRegistry

Doc from javax.imageio.spi.RegisterableService.onRegistration.

a ServiceRegistry where this object has been registered.

category:Class<?>

Doc from javax.imageio.spi.RegisterableService.onRegistration.

a Class object indicating the registry category under which this object has been registered.