| java.lang.Object
 javax.imageio.spi.IIOServiceProvider
javax.imageio.spi.ImageReaderWriterSpi
All known Subclasses: javax.imageio.spi.ImageReaderSpi, javax.imageio.spi.ImageWriterSpi,
| Field Summary | |
| protected String[] | MIMETypes
An array of strings to be returned from
getMIMETypes, initially null. | | protected String[] | extraImageMetadataFormatClassNames
An array of Strings containing the class names of
any additional image metadata formats supported by this
plug-in, initially null. | | protected String[] | extraImageMetadataFormatNames
An array of Strings containing the names of any
additional image metadata formats supported by this plug-in,
initially null. | | protected String[] | extraStreamMetadataFormatClassNames
An array of Strings containing the class names of
any additional stream metadata formats supported by this plug-in,
initially null. | | protected String[] | extraStreamMetadataFormatNames
An array of Strings containing the names of any
additional stream metadata formats supported by this plug-in,
initially null. | | protected String[] | names
An array of strings to be returned from
getFormatNames, initially null. | | protected String | nativeImageMetadataFormatClassName
A String containing the class name of the
native stream metadata format supported by this plug-in,
initially null. | | protected String | nativeImageMetadataFormatName
A String containing the name of the
native stream metadata format supported by this plug-in,
initially null. | | protected String | nativeStreamMetadataFormatClassName
A String containing the class name of the native
stream metadata format supported by this plug-in, initially
null. | | protected String | nativeStreamMetadataFormatName
A String containing the name of the native stream
metadata format supported by this plug-in, initially
null. | | protected String | pluginClassName
A String containing the name of the associated
plug-in class, initially null. | | protected String[] | suffixes
An array of strings to be returned from
getFileSuffixes, initially null. | | protected boolean | supportsStandardImageMetadataFormat
A boolean indicating whether this plug-in supports the
standard metadata format for image metadata, initially
false. | | protected boolean | supportsStandardStreamMetadataFormat
A boolean indicating whether this plug-in supports the
standard metadata format for stream metadata, initially
false. |
| Constructor Summary | |
| 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 an ImageReaderWriterSpi with a given
set of values.
Parameters:
vendorName - the vendor name, as a non-nullString.
Parameters:
version - a version identifier, as a non-nullString.
Parameters:
names - a non-null array ofStrings indicating the format names. | | public | ImageReaderWriterSpi()
Constructs a blank ImageReaderWriterSpi. |
| Method Summary | |
| public String[] | getExtraImageMetadataFormatNames()
Returns an array of Strings containing the names
of additional document formats, other than the native and
standard formats, recognized by the
getAsTree and setFromTree methods on
the image metadata objects produced or consumed by this
plug-in. | | public String[] | getExtraStreamMetadataFormatNames()
Returns an array of Strings containing the names
of additional document formats, other than the native and
standard formats, recognized by the
getAsTree and setFromTree methods on
the stream metadata objects produced or consumed by this
plug-in. | | public String[] | getFileSuffixes()
Returns an array of Strings containing a list of
file suffixes associated with the formats that are generally
usable by the ImageReader or
ImageWriter implementation associated with this
service provider. | | public String[] | getFormatNames()
Returns an array of Strings containing
human-readable names for the formats that are generally usable
by the ImageReader or ImageWriter
implementation associated with this service provider. | | public IIOMetadataFormat | getImageMetadataFormat(String formatName)
Returns an IIOMetadataFormat object describing the
given image metadata format, or null if no
description is available. | | public String[] | getMIMETypes()
Returns an array of Strings containing a list of
MIME types associated with the formats that are generally
usable by the ImageReader or
ImageWriter implementation associated with this
service provider.
Ideally, only a single MIME type would be required in order
to describe a particular format. | | public String | getNativeImageMetadataFormatName()
Returns the name of the "native" image metadata format for
this plug-in, which typically allows for lossless encoding and
transmission of the image metadata stored in the format handled by
this plug-in. | | public String | getNativeStreamMetadataFormatName()
Returns the name of the "native" stream metadata format for
this plug-in, which typically allows for lossless encoding and
transmission of the stream metadata stored in the format handled by
this plug-in. | | public String | getPluginClassName()
Returns the fully-qualified class name of the
ImageReader or ImageWriter plug-in
associated with this service provider. | | public IIOMetadataFormat | getStreamMetadataFormat(String formatName)
Returns an IIOMetadataFormat object describing the
given stream metadata format, or null if no
description is available. | | public boolean | isStandardImageMetadataFormatSupported()
Returns true if the standard metadata format is
among the document formats recognized by the
getAsTree and setFromTree methods on
the image metadata objects produced or consumed by this
plug-in. | | public boolean | isStandardStreamMetadataFormatSupported()
Returns true if the standard metadata format is
among the document formats recognized by the
getAsTree and setFromTree methods on
the stream metadata objects produced or consumed by this
plug-in. |
| MIMETypes | | protected String[] MIMETypes(Code) | | An array of strings to be returned from
getMIMETypes, initially null.
|
| extraImageMetadataFormatClassNames | | protected String[] extraImageMetadataFormatClassNames(Code) | | An array of Strings containing the class names of
any additional image metadata formats supported by this
plug-in, initially null.
|
| extraImageMetadataFormatNames | | protected String[] extraImageMetadataFormatNames(Code) | | An array of Strings containing the names of any
additional image metadata formats supported by this plug-in,
initially null.
|
| extraStreamMetadataFormatClassNames | | protected String[] extraStreamMetadataFormatClassNames(Code) | | An array of Strings containing the class names of
any additional stream metadata formats supported by this plug-in,
initially null.
|
| extraStreamMetadataFormatNames | | protected String[] extraStreamMetadataFormatNames(Code) | | An array of Strings containing the names of any
additional stream metadata formats supported by this plug-in,
initially null.
|
| names | | protected String[] names(Code) | | An array of strings to be returned from
getFormatNames, initially null.
Constructors should set this to a non-null value.
|
| nativeImageMetadataFormatClassName | | protected String nativeImageMetadataFormatClassName(Code) | | A String containing the class name of the
native stream metadata format supported by this plug-in,
initially null.
|
| nativeImageMetadataFormatName | | protected String nativeImageMetadataFormatName(Code) | | A String containing the name of the
native stream metadata format supported by this plug-in,
initially null.
|
| nativeStreamMetadataFormatClassName | | protected String nativeStreamMetadataFormatClassName(Code) | | A String containing the class name of the native
stream metadata format supported by this plug-in, initially
null.
|
| nativeStreamMetadataFormatName | | protected String nativeStreamMetadataFormatName(Code) | | A String containing the name of the native stream
metadata format supported by this plug-in, initially
null.
|
| pluginClassName | | protected String pluginClassName(Code) | | A String containing the name of the associated
plug-in class, initially null.
|
| suffixes | | protected String[] suffixes(Code) | | An array of strings to be returned from
getFileSuffixes, initially null.
|
| supportsStandardImageMetadataFormat | | protected boolean supportsStandardImageMetadataFormat(Code) | | A boolean indicating whether this plug-in supports the
standard metadata format for image metadata, initially
false.
|
| supportsStandardStreamMetadataFormat | | protected boolean supportsStandardStreamMetadataFormat(Code) | | A boolean indicating whether this plug-in supports the
standard metadata format for stream metadata, initially
false.
|
| ImageReaderWriterSpi | | 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)(Code) | | Constructs an ImageReaderWriterSpi with a given
set of values.
Parameters:
vendorName - the vendor name, as a non-nullString.
Parameters:
version - a version identifier, as a non-nullString.
Parameters:
names - a non-null array ofStrings indicating the format names. At least oneentry must be present.
Parameters:
suffixes - an array of Strings indicating thecommon file suffixes. If no suffixes are defined,null should be supplied. An array of length 0will be normalized to null.
Parameters:
MIMETypes - an array of Strings indicatingthe format's MIME types. If no MIME types are defined,null should be supplied. An array of length 0will be normalized to null.
Parameters:
pluginClassName - the fully-qualified name of theassociated ImageReader or ImageWriterclass, as a non-null String.
Parameters:
supportsStandardStreamMetadataFormat - aboolean that indicates whether a stream metadataobject can use trees described by the standard metadata format.
Parameters:
nativeStreamMetadataFormatName - aString, or null, to be returned fromgetNativeStreamMetadataFormatName.
Parameters:
nativeStreamMetadataFormatClassName - aString, or null, to be used to instantiatea metadata format object to be returned fromgetNativeStreamMetadataFormat.
Parameters:
extraStreamMetadataFormatNames - an array ofStrings, or null, to be returned fromgetExtraStreamMetadataFormatNames. An array of length0 is normalized to null.
Parameters:
extraStreamMetadataFormatClassNames - an array ofStrings, or null, to be used to instantiatea metadata format object to be returned fromgetStreamMetadataFormat. An array of length0 is normalized to null.
Parameters:
supportsStandardImageMetadataFormat - aboolean that indicates whether an image metadataobject can use trees described by the standard metadata format.
Parameters:
nativeImageMetadataFormatName - aString, or null, to be returned fromgetNativeImageMetadataFormatName.
Parameters:
nativeImageMetadataFormatClassName - aString, or null, to be used to instantiatea metadata format object to be returned fromgetNativeImageMetadataFormat.
Parameters:
extraImageMetadataFormatNames - an array ofStrings to be returned fromgetExtraImageMetadataFormatNames. An array of length 0is normalized to null.
Parameters:
extraImageMetadataFormatClassNames - an array ofStrings, or null, to be used to instantiatea metadata format object to be returned fromgetImageMetadataFormat. An array of length0 is normalized to null.
exception:
IllegalArgumentException - if vendorNameis null.
exception:
IllegalArgumentException - if versionis null.
exception:
IllegalArgumentException - if namesis null or has length 0.
exception:
IllegalArgumentException - if pluginClassNameis null. |
| ImageReaderWriterSpi | | public ImageReaderWriterSpi()(Code) | | Constructs a blank ImageReaderWriterSpi. It is up
to the subclass to initialize instance variables and/or
override method implementations in order to provide working
versions of all methods.
|
| getExtraImageMetadataFormatNames | | public String[] getExtraImageMetadataFormatNames()(Code) | | Returns an array of Strings containing the names
of additional document formats, other than the native and
standard formats, recognized by the
getAsTree and setFromTree methods on
the image metadata objects produced or consumed by this
plug-in.
If the plug-in does not handle image metadata, null should
be returned.
The set of formats may differ according to the particular
images being read or written; this method should indicate all
the additional formats supported by the plug-in under any circumstances.
The default implementation returns a clone of the
extraImageMetadataFormatNames instance variable,
which is typically set by the constructor.
an array of Strings, or null.
See Also: IIOMetadata.getMetadataFormatNames
See Also: ImageReaderWriterSpi.getExtraStreamMetadataFormatNames
See Also: ImageReaderWriterSpi.getNativeImageMetadataFormatName |
| getExtraStreamMetadataFormatNames | | public String[] getExtraStreamMetadataFormatNames()(Code) | | Returns an array of Strings containing the names
of additional document formats, other than the native and
standard formats, recognized by the
getAsTree and setFromTree methods on
the stream metadata objects produced or consumed by this
plug-in.
If the plug-in does not handle metadata, null should be
returned.
The set of formats may differ according to the particular
images being read or written; this method should indicate all
the additional formats supported by the plug-in under any
circumstances.
The default implementation returns a clone of the
extraStreamMetadataFormatNames instance variable,
which is typically set by the constructor.
an array of Strings, or null.
See Also: IIOMetadata.getMetadataFormatNames
See Also: ImageReaderWriterSpi.getExtraImageMetadataFormatNames
See Also: ImageReaderWriterSpi.getNativeStreamMetadataFormatName |
| getFileSuffixes | | public String[] getFileSuffixes()(Code) | | Returns an array of Strings containing a list of
file suffixes associated with the formats that are generally
usable by the ImageReader or
ImageWriter implementation associated with this
service provider. For example, a single
ImageReader might be able to process files with
'.pbm' and '.pnm' suffixes, or both '.jpg' and '.jpeg'
suffixes. If there are no known file suffixes,
null will be returned.
Returning a particular suffix does not guarantee that files
with that suffix can be processed; it merely indicates that it
may be worthwhile attempting to decode or encode such files
using this service provider.
an array of Strings or length at least 1containing common file suffixes associated with this reader orwriter, or null. |
| getFormatNames | | public String[] getFormatNames()(Code) | | Returns an array of Strings containing
human-readable names for the formats that are generally usable
by the ImageReader or ImageWriter
implementation associated with this service provider. For
example, a single ImageReader might be able to
process both PBM and PNM files.
a non-null array of Stringsor length at least 1 containing informal format namesassociated with this reader or writer. |
| getImageMetadataFormat | | public IIOMetadataFormat getImageMetadataFormat(String formatName)(Code) | | Returns an IIOMetadataFormat object describing the
given image metadata format, or null if no
description is available. The supplied name must be the native
iamge metadata format name, the standard metadata format name,
or one of those returned by
getExtraImageMetadataFormatNames.
Parameters:
formatName - the desired image metadata format. an IIOMetadataFormat object.
exception:
IllegalArgumentException - if formatNameis null or is not a supported name. |
| getMIMETypes | | public String[] getMIMETypes()(Code) | | Returns an array of Strings containing a list of
MIME types associated with the formats that are generally
usable by the ImageReader or
ImageWriter implementation associated with this
service provider.
Ideally, only a single MIME type would be required in order
to describe a particular format. However, for several reasons
it is necessary to associate a list of types with each service
provider. First, many common image file formats do not have
standard MIME types, so a list of commonly used unofficial
names will be required, such as image/x-pbm and
image/x-portable-bitmap. Some file formats have
official MIME types but may sometimes be referred to using
their previous unofficial designations, such as
image/x-png instead of the official
image/png. Finally, a single service provider may
be capable of parsing multiple distinct types from the MIME
point of view, for example image/x-xbitmap and
image/x-xpixmap.
Returning a particular MIME type does not guarantee that
files claiming to be of that type can be processed; it merely
indicates that it may be worthwhile attempting to decode or
encode such files using this service provider.
an array of Strings or length at least 1containing MIME types associated with this reader or writer, ornull. |
| getNativeImageMetadataFormatName | | public String getNativeImageMetadataFormatName()(Code) | | Returns the name of the "native" image metadata format for
this plug-in, which typically allows for lossless encoding and
transmission of the image metadata stored in the format handled by
this plug-in. If no such format is supported,
nullwill be returned.
The default implementation returns the
nativeImageMetadataFormatName instance variable,
which is typically set by the constructor.
the name of the native image metadata format, ornull.
See Also: ImageReaderWriterSpi.getExtraImageMetadataFormatNames |
| getNativeStreamMetadataFormatName | | public String getNativeStreamMetadataFormatName()(Code) | | Returns the name of the "native" stream metadata format for
this plug-in, which typically allows for lossless encoding and
transmission of the stream metadata stored in the format handled by
this plug-in. If no such format is supported,
nullwill be returned.
The default implementation returns the
nativeStreamMetadataFormatName instance variable,
which is typically set by the constructor.
the name of the native stream metadata format, ornull. |
| getPluginClassName | | public String getPluginClassName()(Code) | | Returns the fully-qualified class name of the
ImageReader or ImageWriter plug-in
associated with this service provider.
the class name, as a non-nullString. |
| getStreamMetadataFormat | | public IIOMetadataFormat getStreamMetadataFormat(String formatName)(Code) | | Returns an IIOMetadataFormat object describing the
given stream metadata format, or null if no
description is available. The supplied name must be the native
stream metadata format name, the standard metadata format name,
or one of those returned by
getExtraStreamMetadataFormatNames.
Parameters:
formatName - the desired stream metadata format. an IIOMetadataFormat object.
exception:
IllegalArgumentException - if formatNameis null or is not a supported name. |
| isStandardImageMetadataFormatSupported | | public boolean isStandardImageMetadataFormatSupported()(Code) | | Returns true if the standard metadata format is
among the document formats recognized by the
getAsTree and setFromTree methods on
the image metadata objects produced or consumed by this
plug-in.
true if the standard format is supportedfor image metadata. |
| isStandardStreamMetadataFormatSupported | | public boolean isStandardStreamMetadataFormatSupported()(Code) | | Returns true if the standard metadata format is
among the document formats recognized by the
getAsTree and setFromTree methods on
the stream metadata objects produced or consumed by this
plug-in.
true if the standard format is supportedfor stream metadata. |
|
|