Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
javax.imageio.spi.IIOServiceProvider
javax.imageio.spi.ImageReaderWriterSpi
public abstract class ImageReaderWriterSpi
extends IIOServiceProvider
ImageReaderSpi
and ImageWriterSpi
.
Field Summary | |
protected String[] |
|
protected String[] | |
protected String[] |
|
protected String[] | |
protected String[] |
|
protected String[] |
|
protected String | |
protected String |
|
protected String | |
protected String |
|
protected String |
|
protected String[] |
|
protected boolean |
|
protected boolean |
|
Fields inherited from class javax.imageio.spi.IIOServiceProvider | |
vendorName , version |
Constructor Summary | |
| |
|
Method Summary | |
String[] |
|
String[] |
|
String[] |
|
String[] |
|
IIOMetadataFormat |
|
String[] |
|
String |
|
String |
|
String |
|
IIOMetadataFormat |
|
boolean |
|
boolean |
|
Methods inherited from class javax.imageio.spi.IIOServiceProvider | |
getDescription , getVendorName , getVersion , onDeregistration , onRegistration |
Methods inherited from class java.lang.Object | |
clone , equals , extends Object> getClass , finalize , hashCode , notify , notifyAll , toString , wait , wait , wait |
protected String[] MIMETypes
The MIME types of the supported image formats. This value should be non-null
after construction.
- See Also:
getMIMETypes()
protected String[] names
The human-readable, localized names of the supported image formats. This value should be non-null
after construction.
- See Also:
getFormatNames()
protected String nativeImageMetadataFormatName
The name of the format that allows encoding all image metadata without loss, ornull
if this plug-in does not provide a format that preserves all image metadata.
protected String nativeStreamMetadataFormatName
The name of the format that allows encoding all stream metadata without loss, ornull
if this plug-in does not provide a format that preserves all stream metadata.
protected String pluginClassName
The fully qualified name of the class that implements theImageReader
orImageWriter
interface. This value should be non-null
after construction.
- See Also:
getPluginClassName()
protected String[] suffixes
The file suffixes of the supported image formats. This value should be non-null
after construction.
- See Also:
getFileSuffixes()
protected boolean supportsStandardImageMetadataFormat
Indicates whether the per-image metadata objects associated with this plug-in support format“javax_imageio_1.0”
in theirgetAsTree
andsetAsTree
methods.
protected boolean supportsStandardStreamMetadataFormat
Indicates whether the per-stream metadata objects associated with this plug-in support format“javax_imageio_1.0”
in theirgetAsTree
andsetAsTree
methods.
public ImageReaderWriterSpi()
Constructs anImageReaderWriteSpi
instance, without specifying a number of parameters. Constructors of concrete subclasses must ensure that they set all inherited fields to meaningful values.
public ImageReaderWriterSpi(String vendorName, String version, String[] names, String[] suffixes, String[] MIMETypes, String pluginClassName, boolean supportsStandardStreamMetadataFormat, String nativeStreamMetadataFormatName, String nativeStreamMetadataFormatClassName, String[] extraStreamMetadataFormatNames, String[] extraStreamMetadataFormatClassNames, boolean supportsStandardImageMetadataFormat, String nativeImageMetadataFormatName, String nativeImageMetadataFormatClassName, String[] extraImageMetadataFormatNames, String[] extraImageMetadataFormatClassNames)
Constructs anImageReaderWriteSpi
instance, specifying a number of parameters.
- Parameters:
names
- the human-readable, localized names of the supported image formats, for example[“Tagged Image File Format”, “Portable Network Graphics”]
.suffixes
- the file suffixes of the supported image formats, for example[“tiff”, “tif”, “png”]
.MIMETypes
- the MIME types of the supported image formats, for example[“image/tiff”, “image/png”]
.pluginClassName
- the fully qualified name of the class that implements theImageReader
orImageWriter
interface.supportsStandardStreamMetadataFormat
- whether the per-stream metadata objects associated with this plug-in support format“javax_imageio_1.0”
in theirgetAsTree
andsetAsTree
methods.nativeStreamMetadataFormatName
- the name of the format that allows encoding all stream metadata without loss, ornull
if this plug-in does not provide a format that preserves all stream metadata.extraStreamMetadataFormatNames
- the names of additional formats for encoding stream metadata, other than the standard and the native formats, ornull
if this plug-in does not provide any extra formats.supportsStandardImageMetadataFormat
- whether the per-image metadata objects associated with this plug-in support format“javax_imageio_1.0”
in theirgetAsTree
andsetAsTree
methods.nativeImageMetadataFormatName
- the name of the format that allows encoding all image metadata without loss, ornull
if this plug-in does not provide a format that preserves all image metadata.extraImageMetadataFormatNames
- the names of additional formats for encoding image metadata, other than the standard and the native formats, ornull
if this plug-in does not provide any extra formats.
- Throws:
IllegalArgumentException
- ifvendorName
orversion
isnull
.
public String[] getExtraImageMetadataFormatNames()
Returns the names of additional formats for encoding image metadata, other than the standard and the native formats, ornull
if this plug-in does not provide any extra formats.
- See Also:
getExtraStreamMetadataFormatNames()
public String[] getExtraStreamMetadataFormatNames()
Returns the names of additional formats for encoding stream metadata, other than the standard and the native formats, ornull
if this plug-in does not provide any extra formats.
- See Also:
getExtraImageMetadataFormatNames()
public String[] getFileSuffixes()
Returns the file suffixes of the supported image formats, for example[“tiff”, “tif”, “png”]
.
public String[] getFormatNames()
Returns the human-readable, localized names of the supported image formats. For example, a plug-in might return an array with the elements[“Tagged Image File Format”, “Portable Network Graphics”]
.
public IIOMetadataFormat getImageMetadataFormat(String formatName)
Returns an IIOMetadataFormat object that represents the requested image metadata format or null if the given format is supported but no IIOMetadataFormat can be created for it.
- Parameters:
formatName
- the requested image metadata format name
- Returns:
- an IIOMetadataFormat object or null
- Throws:
IllegalArgumentException
- if formatName is null or is not one of the standard metadata format or this provider's native or extra image metadata formats
public String[] getMIMETypes()
Returns the MIME types of the supported image formats, for example[“image/tiff”, “image/png”]
.
- Returns:
- an array of MIME type strings, or
null
if none of the supported formats has an associated MIME type.
public String getNativeImageMetadataFormatName()
Returns the name of the format that allows encoding all image metadata without loss, ornull
if this plug-in does not provide a format that preserves all image metadata.
- See Also:
getNativeStreamMetadataFormatName()
public String getNativeStreamMetadataFormatName()
Returns the name of the format that allows encoding all stream metadata without loss, ornull
if this plug-in does not provide a format that preserves all stream metadata.
- See Also:
getNativeImageMetadataFormatName()
public String getPluginClassName()
Returns the fully qualified name of the class that implements theImageReader
orImageWriter
interface.
public IIOMetadataFormat getStreamMetadataFormat(String formatName)
Returns an IIOMetadataFormat object that represents the requested stream metadata format or null if the given format is supported but no IIOMetadataFormat can be created for it.
- Parameters:
formatName
- the requested stream metadata format name
- Returns:
- an IIOMetadataFormat object or null
- Throws:
IllegalArgumentException
- if formatName is null or is not one of the standard metadata format or this provider's native or extra stream metadata formats
public boolean isStandardImageMetadataFormatSupported()
Returns whether the per-image metadata objects associated with this plug-in support format“javax_imageio_1.0”
in theirgetAsTree
andsetAsTree
methods.
public boolean isStandardStreamMetadataFormatSupported()
Returns whether the per-stream metadata objects associated with this plug-in support format“javax_imageio_1.0”
in theirgetAsTree
andsetAsTree
methods.