public abstract class ImageReaderWriterSpi extends IIOServiceProvider
ImageReaderSpi
and ImageWriterSpi
.Modifier and Type | Field and Description |
---|---|
protected String[] |
extraImageMetadataFormatClassNames |
protected String[] |
extraImageMetadataFormatNames
|
protected String[] |
extraStreamMetadataFormatClassNames |
protected String[] |
extraStreamMetadataFormatNames
|
protected String[] |
MIMETypes
The MIME types of the supported image formats.
|
protected String[] |
names
The human-readable, localized names of the supported image
formats.
|
protected String |
nativeImageMetadataFormatClassName |
protected String |
nativeImageMetadataFormatName
The name of the format that allows encoding all image metadata
without loss, or
null if this plug-in does not
provide a format that preserves all image metadata. |
protected String |
nativeStreamMetadataFormatClassName |
protected String |
nativeStreamMetadataFormatName
The name of the format that allows encoding all stream metadata
without loss, or
null 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 the
ImageReader or ImageWriter
interface. |
protected String[] |
suffixes
The file suffixes of the supported image formats.
|
protected boolean |
supportsStandardImageMetadataFormat
Indicates whether the per-image metadata objects associated
with this plug-in support format
“javax_imageio_1.0” in their
getAsTree and setAsTree methods. |
protected boolean |
supportsStandardStreamMetadataFormat
Indicates whether the per-stream metadata objects associated
with this plug-in support format
“javax_imageio_1.0” in their
getAsTree and setAsTree methods. |
vendorName, version
Constructor and Description |
---|
ImageReaderWriterSpi()
Constructs an
ImageReaderWriteSpi instance, without
specifying a number of parameters. |
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 an
ImageReaderWriteSpi instance,
specifying a number of parameters. |
Modifier and Type | Method and Description |
---|---|
String[] |
getExtraImageMetadataFormatNames()
|
String[] |
getExtraStreamMetadataFormatNames()
|
String[] |
getFileSuffixes()
Returns the file suffixes of the supported image formats, for
example
[“tiff”, “tif”,
“png”] . |
String[] |
getFormatNames()
Returns the human-readable, localized names of the supported
image formats.
|
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.
|
String[] |
getMIMETypes()
Returns the MIME types of the supported image formats, for
example
[“image/tiff”,
“image/png”] . |
String |
getNativeImageMetadataFormatName()
Returns the name of the format that allows encoding all image
metadata without loss, or
null if this plug-in does
not provide a format that preserves all image metadata. |
String |
getNativeStreamMetadataFormatName()
Returns the name of the format that allows encoding all stream
metadata without loss, or
null if this plug-in does
not provide a format that preserves all stream metadata. |
String |
getPluginClassName()
Returns the fully qualified name of the class that implements the
ImageReader or ImageWriter interface. |
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.
|
boolean |
isStandardImageMetadataFormatSupported()
Returns whether the per-image metadata objects associated
with this plug-in support format
“javax_imageio_1.0” in their
getAsTree and setAsTree methods. |
boolean |
isStandardStreamMetadataFormatSupported()
Returns whether the per-stream metadata objects associated
with this plug-in support format
“javax_imageio_1.0” in their
getAsTree and setAsTree methods. |
getDescription, getVendorName, getVersion, onDeregistration, onRegistration
protected String[] names
null
after
construction.getFormatNames()
protected String[] suffixes
null
after construction.getFileSuffixes()
protected String[] MIMETypes
null
after construction.getMIMETypes()
protected String pluginClassName
ImageReader
or ImageWriter
interface. This value should be non-null
after
construction.getPluginClassName()
protected boolean supportsStandardStreamMetadataFormat
“javax_imageio_1.0”
in their
getAsTree
and setAsTree
methods.protected String nativeStreamMetadataFormatName
null
if this plug-in does not
provide a format that preserves all stream metadata.protected String nativeStreamMetadataFormatClassName
protected String[] extraStreamMetadataFormatNames
protected String[] extraStreamMetadataFormatClassNames
protected boolean supportsStandardImageMetadataFormat
“javax_imageio_1.0”
in their
getAsTree
and setAsTree
methods.protected String nativeImageMetadataFormatName
null
if this plug-in does not
provide a format that preserves all image metadata.protected String nativeImageMetadataFormatClassName
protected String[] extraImageMetadataFormatNames
protected String[] extraImageMetadataFormatClassNames
public ImageReaderWriterSpi()
ImageReaderWriteSpi
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)
ImageReaderWriteSpi
instance,
specifying a number of 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 the ImageReader
or ImageWriter
interface.supportsStandardStreamMetadataFormat
- whether the
per-stream metadata objects associated with this plug-in support format
“javax_imageio_1.0”
in their
getAsTree
and setAsTree
methods.nativeStreamMetadataFormatName
- the name of the format that
allows encoding all stream metadata without loss, or
null
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,
or null
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 their
getAsTree
and setAsTree
methods.nativeImageMetadataFormatName
- the name of the format that
allows encoding all image metadata without loss, or
null
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,
or null
if this plug-in does not provide any extra
formats.IllegalArgumentException
- if vendorName
or version
is null
.public String[] getFormatNames()
[“Tagged Image File Format”,
“Portable Network Graphics”]
.public String[] getFileSuffixes()
[“tiff”, “tif”,
“png”]
.public String[] getMIMETypes()
[“image/tiff”,
“image/png”]
.null
if
none of the supported formats has an associated MIME type.public String getPluginClassName()
ImageReader
or ImageWriter
interface.public boolean isStandardStreamMetadataFormatSupported()
“javax_imageio_1.0”
in their
getAsTree
and setAsTree
methods.public String getNativeStreamMetadataFormatName()
null
if this plug-in does
not provide a format that preserves all stream metadata.getNativeImageMetadataFormatName()
public String[] getExtraStreamMetadataFormatNames()
null
if this plug-in does not provide any extra
formats.getExtraImageMetadataFormatNames()
public boolean isStandardImageMetadataFormatSupported()
“javax_imageio_1.0”
in their
getAsTree
and setAsTree
methods.public String getNativeImageMetadataFormatName()
null
if this plug-in does
not provide a format that preserves all image metadata.getNativeStreamMetadataFormatName()
public String[] getExtraImageMetadataFormatNames()
null
if this plug-in does not provide any extra
formats.getExtraStreamMetadataFormatNames()
public IIOMetadataFormat getStreamMetadataFormat(String formatName)
formatName
- the requested stream metadata format nameIllegalArgumentException
- if formatName is null or is not
one of the standard metadata format or this provider's native or
extra stream metadata formatspublic IIOMetadataFormat getImageMetadataFormat(String formatName)
formatName
- the requested image metadata format nameIllegalArgumentException
- if formatName is null or is not
one of the standard metadata format or this provider's native or
extra image metadata formats