Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> imageio >> [ spi overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

javax.imageio.spi
Class ImageReaderWriterSpi  

java.lang.Object
  javax.imageio.spi.IIOServiceProvider
      javax.imageio.spi.ImageReaderWriterSpi

All Implemented Interfaces:

RegisterableService

Direct Known Subclasses:

ImageReaderSpi, ImageWriterSpi

---

public abstract class ImageReaderWriterSpi

extends IIOServiceProvider

An abstract superclass that contains the common parts of ImageReaderSpi and ImageWriterSpi.

Since:

1.4

---

Field Summary
protected  java.lang.String[]	extraImageMetadataFormatClassNames
protected  java.lang.String[]	extraImageMetadataFormatNames           The names of additional formats for encoding image metadata, other than the standard 55 and the native 55 formats, or null if this plug-in does not provide any extra formats.
protected  java.lang.String[]	extraStreamMetadataFormatClassNames
protected  java.lang.String[]	extraStreamMetadataFormatNames           The names of additional formats for encoding stream metadata, other than the standard 55 and the native 55 formats, or null if this plug-in does not provide any extra formats.
protected  java.lang.String[]	MIMETypes           The MIME types of the supported image formats.
protected  java.lang.String[]	names           The human-readable, localized names of the supported image formats.
protected  java.lang.String	nativeImageMetadataFormatClassName
protected  java.lang.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  java.lang.String	nativeStreamMetadataFormatClassName
protected  java.lang.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  java.lang.String	pluginClassName           The fully qualified name of the class that implements the javax.imageio.ImageReader or javax.imageio.ImageWriter interface.
protected  java.lang.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.

 

Fields inherited from class javax.imageio.spi.IIOServiceProvider

vendorName, version

 

Constructor Summary

ImageReaderWriterSpi()           Constructs an ImageReaderWriteSpi instance, without specifying a number of parameters.

ImageReaderWriterSpi(java.lang.String vendorName, java.lang.String version, java.lang.String[] names, java.lang.String[] suffixes, java.lang.String[] MIMETypes, java.lang.String pluginClassName, boolean supportsStandardStreamMetadataFormat, java.lang.String nativeStreamMetadataFormatName, java.lang.String nativeStreamMetadataFormatClassName, java.lang.String[] extraStreamMetadataFormatNames, java.lang.String[] extraStreamMetadataFormatClassNames, boolean supportsStandardImageMetadataFormat, java.lang.String nativeImageMetadataFormatName, java.lang.String nativeImageMetadataFormatClassName, java.lang.String[] extraImageMetadataFormatNames, java.lang.String[] extraImageMetadataFormatClassNames)           Constructs an ImageReaderWriteSpi instance, specifying a number of parameters.

 

Method Summary
java.lang.String[]	getExtraImageMetadataFormatNames()           Returns the names of additional formats for encoding image metadata, other than the standard 55 and the native 55 formats, or null if this plug-in does not provide any extra formats.
java.lang.String[]	getExtraStreamMetadataFormatNames()           Returns the names of additional formats for encoding stream metadata, other than the standard 55 and the native 55 formats, or null if this plug-in does not provide any extra formats.
java.lang.String[]	getFileSuffixes()           Returns the file suffixes of the supported image formats, for example [“tiff”, “tif”, “png”].
java.lang.String[]	getFormatNames()           Returns the human-readable, localized names of the supported image formats.
javax.imageio.metadata.IIOMetadataFormat	getImageMetadataFormat(java.lang.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.
java.lang.String[]	getMIMETypes()           Returns the MIME types of the supported image formats, for example [“image/tiff”, “image/png”].
java.lang.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.
java.lang.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.
java.lang.String	getPluginClassName()           Returns the fully qualified name of the class that implements the javax.imageio.ImageReader or javax.imageio.ImageWriter interface.
javax.imageio.metadata.IIOMetadataFormat	getStreamMetadataFormat(java.lang.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.

 

Methods inherited from class javax.imageio.spi.IIOServiceProvider

getDescription, getVendorName, getVersion, onDeregistration, onRegistration

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

names

protected java.lang.String[] names

The human-readable, localized names of the supported image formats. This value should be non-null after construction.

See Also:

getFormatNames() 55

---

suffixes

protected java.lang.String[] suffixes

The file suffixes of the supported image formats. This value should be non-null after construction.

See Also:

getFileSuffixes() 55

---

MIMETypes

protected java.lang.String[] MIMETypes

The MIME types of the supported image formats. This value should be non-null after construction.

See Also:

getMIMETypes() 55

---

pluginClassName

protected java.lang.String pluginClassName

The fully qualified name of the class that implements the javax.imageio.ImageReader or javax.imageio.ImageWriter interface. This value should be non-null after construction.

See Also:

getPluginClassName() 55

---

supportsStandardStreamMetadataFormat

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.

See Also:

isStandardStreamMetadataFormatSupported() 55

---

nativeStreamMetadataFormatName

protected java.lang.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.

---

nativeStreamMetadataFormatClassName

protected java.lang.String nativeStreamMetadataFormatClassName

---

extraStreamMetadataFormatNames

protected java.lang.String[] extraStreamMetadataFormatNames

The names of additional formats for encoding stream metadata, other than the standard 55 and the native 55 formats, or null if this plug-in does not provide any extra formats.

---

extraStreamMetadataFormatClassNames

protected java.lang.String[] extraStreamMetadataFormatClassNames

---

supportsStandardImageMetadataFormat

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.

See Also:

isStandardImageMetadataFormatSupported() 55

---

nativeImageMetadataFormatName

protected java.lang.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.

---

nativeImageMetadataFormatClassName

protected java.lang.String nativeImageMetadataFormatClassName

---

extraImageMetadataFormatNames

protected java.lang.String[] extraImageMetadataFormatNames

The names of additional formats for encoding image metadata, other than the standard 55 and the native 55 formats, or null if this plug-in does not provide any extra formats.

---

extraImageMetadataFormatClassNames

protected java.lang.String[] extraImageMetadataFormatClassNames

Constructor Detail

ImageReaderWriterSpi

public ImageReaderWriterSpi()

Constructs an ImageReaderWriteSpi instance, without specifying a number of parameters. Constructors of concrete subclasses must ensure that they set all inherited fields to meaningful values.

---

ImageReaderWriterSpi

public ImageReaderWriterSpi(java.lang.String vendorName,
                            java.lang.String version,
                            java.lang.String[] names,
                            java.lang.String[] suffixes,
                            java.lang.String[] MIMETypes,
                            java.lang.String pluginClassName,
                            boolean supportsStandardStreamMetadataFormat,
                            java.lang.String nativeStreamMetadataFormatName,
                            java.lang.String nativeStreamMetadataFormatClassName,
                            java.lang.String[] extraStreamMetadataFormatNames,
                            java.lang.String[] extraStreamMetadataFormatClassNames,
                            boolean supportsStandardImageMetadataFormat,
                            java.lang.String nativeImageMetadataFormatName,
                            java.lang.String nativeImageMetadataFormatClassName,
                            java.lang.String[] extraImageMetadataFormatNames,
                            java.lang.String[] extraImageMetadataFormatClassNames)

Constructs an ImageReaderWriteSpi instance, specifying a number of parameters.

Method Detail

getFormatNames

public java.lang.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”].

---

getFileSuffixes

public java.lang.String[] getFileSuffixes()

Returns the file suffixes of the supported image formats, for example [“tiff”, “tif”, “png”].

---

getMIMETypes

public java.lang.String[] getMIMETypes()

Returns the MIME types of the supported image formats, for example [“image/tiff”, “image/png”].

---

getPluginClassName

public java.lang.String getPluginClassName()

Returns the fully qualified name of the class that implements the javax.imageio.ImageReader or javax.imageio.ImageWriter interface.

---

isStandardStreamMetadataFormatSupported

public 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.

---

getNativeStreamMetadataFormatName

public java.lang.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.

---

getExtraStreamMetadataFormatNames

public java.lang.String[] getExtraStreamMetadataFormatNames()

Returns the names of additional formats for encoding stream metadata, other than the standard 55 and the native 55 formats, or null if this plug-in does not provide any extra formats.

---

isStandardImageMetadataFormatSupported

public 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.

---

getNativeImageMetadataFormatName

public java.lang.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.

---

getExtraImageMetadataFormatNames

public java.lang.String[] getExtraImageMetadataFormatNames()

Returns the names of additional formats for encoding image metadata, other than the standard 55 and the native 55 formats, or null if this plug-in does not provide any extra formats.

---

getStreamMetadataFormat

public javax.imageio.metadata.IIOMetadataFormat getStreamMetadataFormat(java.lang.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.

---

getImageMetadataFormat

public javax.imageio.metadata.IIOMetadataFormat getImageMetadataFormat(java.lang.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.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> imageio >> [ spi overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---