public abstract class ImageReaderWriterSpi extends IIOServiceProvider
ImageReaderSpi and ImageWriterSpi.IIORegistry, 
ImageReaderSpi, 
ImageWriterSpi| Modifier and Type | Field and Description | 
|---|---|
| protected String[] | extraImageMetadataFormatClassNamesAn array of  Strings containing the class names of
 any additional image metadata formats supported by this
 plug-in, initiallynull. | 
| protected String[] | extraImageMetadataFormatNamesAn array of  Strings containing the names of any
 additional image metadata formats supported by this plug-in,
 initiallynull. | 
| protected String[] | extraStreamMetadataFormatClassNamesAn array of  Strings containing the class names of
 any additional stream metadata formats supported by this plug-in,
 initiallynull. | 
| protected String[] | extraStreamMetadataFormatNamesAn array of  Strings containing the names of any
 additional stream metadata formats supported by this plug-in,
 initiallynull. | 
| protected String[] | MIMETypesAn array of strings to be returned from
  getMIMETypes, initiallynull. | 
| protected String[] | namesAn array of strings to be returned from
  getFormatNames, initiallynull. | 
| protected String | nativeImageMetadataFormatClassNameA  Stringcontaining the class name of the
 native stream metadata format supported by this plug-in,
 initiallynull. | 
| protected String | nativeImageMetadataFormatNameA  Stringcontaining the name of the
 native stream metadata format supported by this plug-in,
 initiallynull. | 
| protected String | nativeStreamMetadataFormatClassNameA  Stringcontaining the class name of the native
 stream metadata format supported by this plug-in, initiallynull. | 
| protected String | nativeStreamMetadataFormatNameA  Stringcontaining the name of the native stream
 metadata format supported by this plug-in, initiallynull. | 
| protected String | pluginClassNameA  Stringcontaining the name of the associated
 plug-in class, initiallynull. | 
| protected String[] | suffixesAn array of strings to be returned from
  getFileSuffixes, initiallynull. | 
| protected boolean | supportsStandardImageMetadataFormatA boolean indicating whether this plug-in supports the
 standard metadata format for image metadata, initially
  false. | 
| protected boolean | supportsStandardStreamMetadataFormatA boolean indicating whether this plug-in supports the
 standard metadata format for stream metadata, initially
  false. | 
vendorName, version| Constructor and Description | 
|---|
| ImageReaderWriterSpi()Constructs a blank  ImageReaderWriterSpi. | 
| 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  ImageReaderWriterSpiwith a given
 set of values. | 
| Modifier and Type | Method and Description | 
|---|---|
| String[] | getExtraImageMetadataFormatNames()Returns an array of  Strings containing the names
 of additional document formats, other than the native and
 standard formats, recognized by thegetAsTreeandsetFromTreemethods on
 the image metadata objects produced or consumed by this
 plug-in. | 
| String[] | getExtraStreamMetadataFormatNames()Returns an array of  Strings containing the names
 of additional document formats, other than the native and
 standard formats, recognized by thegetAsTreeandsetFromTreemethods on
 the stream metadata objects produced or consumed by this
 plug-in. | 
| String[] | getFileSuffixes()Returns an array of  Strings containing a list of
 file suffixes associated with the formats that are generally
 usable by theImageReaderorImageWriterimplementation associated with this
 service provider. | 
| String[] | getFormatNames()Returns an array of  Strings containing
 human-readable names for the formats that are generally usable
 by theImageReaderorImageWriterimplementation associated with this service provider. | 
| IIOMetadataFormat | getImageMetadataFormat(String formatName)Returns an  IIOMetadataFormatobject describing the
 given image metadata format, ornullif no
 description is available. | 
| String[] | getMIMETypes()Returns an array of  Strings containing a list of
 MIME types associated with the formats that are generally
 usable by theImageReaderorImageWriterimplementation associated with this
 service provider. | 
| 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. | 
| 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. | 
| String | getPluginClassName()Returns the fully-qualified class name of the
  ImageReaderorImageWriterplug-in
 associated with this service provider. | 
| IIOMetadataFormat | getStreamMetadataFormat(String formatName)Returns an  IIOMetadataFormatobject describing the
 given stream metadata format, ornullif no
 description is available. | 
| boolean | isStandardImageMetadataFormatSupported()Returns  trueif the standard metadata format is
 among the document formats recognized by thegetAsTreeandsetFromTreemethods on
 the image metadata objects produced or consumed by this
 plug-in. | 
| boolean | isStandardStreamMetadataFormatSupported()Returns  trueif the standard metadata format is
 among the document formats recognized by thegetAsTreeandsetFromTreemethods on
 the stream metadata objects produced or consumed by this
 plug-in. | 
getDescription, getVendorName, getVersion, onDeregistration, onRegistrationprotected String[] names
getFormatNames, initially null.
 Constructors should set this to a non-null value.protected String[] suffixes
getFileSuffixes, initially null.protected String[] MIMETypes
getMIMETypes, initially null.protected String pluginClassName
String containing the name of the associated
 plug-in class, initially null.protected boolean supportsStandardStreamMetadataFormat
false.protected String nativeStreamMetadataFormatName
String containing the name of the native stream
 metadata format supported by this plug-in, initially
 null.protected String nativeStreamMetadataFormatClassName
String containing the class name of the native
 stream metadata format supported by this plug-in, initially
 null.protected String[] extraStreamMetadataFormatNames
Strings containing the names of any
 additional stream metadata formats supported by this plug-in,
 initially null.protected String[] extraStreamMetadataFormatClassNames
Strings containing the class names of
 any additional stream metadata formats supported by this plug-in,
 initially null.protected boolean supportsStandardImageMetadataFormat
false.protected String nativeImageMetadataFormatName
String containing the name of the
 native stream metadata format supported by this plug-in,
 initially null.protected String nativeImageMetadataFormatClassName
String containing the class name of the
 native stream metadata format supported by this plug-in,
 initially null.protected String[] extraImageMetadataFormatNames
Strings containing the names of any
 additional image metadata formats supported by this plug-in,
 initially null.protected String[] extraImageMetadataFormatClassNames
Strings containing the class names of
 any additional image metadata formats supported by this
 plug-in, initially null.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)
ImageReaderWriterSpi with a given
 set of values.vendorName - the vendor name, as a non-null
 String.version - a version identifier, as a non-null
 String.names - a non-null array of
 Strings indicating the format names.  At least one
 entry must be present.suffixes - an array of Strings indicating the
 common file suffixes.  If no suffixes are defined,
 null should be supplied.  An array of length 0
 will be normalized to null.MIMETypes - an array of Strings indicating
 the format's MIME types.  If no MIME types are defined,
 null should be supplied.  An array of length 0
 will be normalized to null.pluginClassName - the fully-qualified name of the
 associated ImageReader or ImageWriter
 class, as a non-null String.supportsStandardStreamMetadataFormat - a
 boolean that indicates whether a stream metadata
 object can use trees described by the standard metadata format.nativeStreamMetadataFormatName - a
 String, or null, to be returned from
 getNativeStreamMetadataFormatName.nativeStreamMetadataFormatClassName - a
 String, or null, to be used to instantiate
 a metadata format object to be returned from
 getNativeStreamMetadataFormat.extraStreamMetadataFormatNames - an array of
 Strings, or null, to be returned from
 getExtraStreamMetadataFormatNames.  An array of length
 0 is normalized to null.extraStreamMetadataFormatClassNames - an array of
 Strings, or null, to be used to instantiate
 a metadata format object to be returned from
 getStreamMetadataFormat.  An array of length
 0 is normalized to null.supportsStandardImageMetadataFormat - a
 boolean that indicates whether an image metadata
 object can use trees described by the standard metadata format.nativeImageMetadataFormatName - a
 String, or null, to be returned from
 getNativeImageMetadataFormatName.nativeImageMetadataFormatClassName - a
 String, or null, to be used to instantiate
 a metadata format object to be returned from
 getNativeImageMetadataFormat.extraImageMetadataFormatNames - an array of
 Strings to be returned from
 getExtraImageMetadataFormatNames.  An array of length 0
 is normalized to null.extraImageMetadataFormatClassNames - an array of
 Strings, or null, to be used to instantiate
 a metadata format object to be returned from
 getImageMetadataFormat.  An array of length
 0 is normalized to null.IllegalArgumentException - if vendorName
 is null.IllegalArgumentException - if version
 is null.IllegalArgumentException - if names
 is null or has length 0.IllegalArgumentException - if pluginClassName
 is null.public ImageReaderWriterSpi()
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.public String[] getFormatNames()
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.null array of Strings
 or length at least 1 containing informal format names
 associated with this reader or writer.public String[] getFileSuffixes()
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.
Strings or length at least 1
 containing common file suffixes associated with this reader or
 writer, or null.public String[] getMIMETypes()
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.
Strings or length at least 1
 containing MIME types associated with this reader or writer, or
 null.public String getPluginClassName()
ImageReader or ImageWriter plug-in
 associated with this service provider.null
 String.public boolean isStandardStreamMetadataFormatSupported()
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 supported
 for stream metadata.public String getNativeStreamMetadataFormatName()
nullwill be returned.
  The default implementation returns the
 nativeStreamMetadataFormatName instance variable,
 which is typically set by the constructor.
null.public String[] getExtraStreamMetadataFormatNames()
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.
Strings, or null.IIOMetadata.getMetadataFormatNames(), 
getExtraImageMetadataFormatNames(), 
getNativeStreamMetadataFormatName()public boolean isStandardImageMetadataFormatSupported()
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 supported
 for image metadata.public String getNativeImageMetadataFormatName()
nullwill be returned.
  The default implementation returns the
 nativeImageMetadataFormatName instance variable,
 which is typically set by the constructor.
null.getExtraImageMetadataFormatNames()public String[] getExtraImageMetadataFormatNames()
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.
Strings, or null.IIOMetadata.getMetadataFormatNames(), 
getExtraStreamMetadataFormatNames(), 
getNativeImageMetadataFormatName()public IIOMetadataFormat getStreamMetadataFormat(String formatName)
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.formatName - the desired stream metadata format.IIOMetadataFormat object.IllegalArgumentException - if formatName
 is null or is not a supported name.public IIOMetadataFormat getImageMetadataFormat(String formatName)
IIOMetadataFormat object describing the
 given image metadata format, or null if no
 description is available.  The supplied name must be the native
 image metadata format name, the standard metadata format name,
 or one of those returned by
 getExtraImageMetadataFormatNames.formatName - the desired image metadata format.IIOMetadataFormat object.IllegalArgumentException - if formatName
 is null or is not a supported name. Submit a bug or feature 
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
 Copyright © 1993, 2017, Oracle and/or its affiliates.  All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.