FileDocCategorySizeDatePackage
ImageReaderWriterSpi.javaAPI DocAndroid 1.5 API12633Wed May 06 22:41:54 BST 2009javax.imageio.spi

ImageReaderWriterSpi

public abstract class ImageReaderWriterSpi extends IIOServiceProvider implements RegisterableService
The ImageReaderWriterSpi class is a superclass for the ImageReaderSpi and ImageWriterSpi SPIs.
since
Android 1.0

Fields Summary
protected String[]
names
The names.
protected String[]
suffixes
The suffixes.
protected String[]
MIMETypes
The MIME types.
protected String
pluginClassName
The plug-in class name.
protected boolean
supportsStandardStreamMetadataFormat
Whether the reader/writer supports standard stream metadata format.
protected String
nativeStreamMetadataFormatName
The native stream metadata format name.
protected String
nativeStreamMetadataFormatClassName
The native stream metadata format class name.
protected String[]
extraStreamMetadataFormatNames
The extra stream metadata format names.
protected String[]
extraStreamMetadataFormatClassNames
The extra stream metadata format class names.
protected boolean
supportsStandardImageMetadataFormat
Whether the reader/writer supports standard image metadata format.
protected String
nativeImageMetadataFormatName
The native image metadata format name.
protected String
nativeImageMetadataFormatClassName
The native image metadata format class name.
protected String[]
extraImageMetadataFormatNames
The extra image metadata format names.
protected String[]
extraImageMetadataFormatClassNames
The extra image metadata format class names.
Constructors 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)
Instantiates a new ImageReaderWriterSpi.

param
vendorName the vendor name.
param
version the version.
param
names the format names.
param
suffixes the array of strings representing the file suffixes.
param
MIMETypes the an array of strings representing MIME types.
param
pluginClassName the plug-in class name.
param
supportsStandardStreamMetadataFormat the value indicating if stream metadata can be described by standard metadata format.
param
nativeStreamMetadataFormatName the native stream metadata format name, returned by getNativeStreamMetadataFormatName.
param
nativeStreamMetadataFormatClassName the native stream metadata format class name, returned by getNativeStreamMetadataFormat.
param
extraStreamMetadataFormatNames the extra stream metadata format names, returned by getExtraStreamMetadataFormatNames.
param
extraStreamMetadataFormatClassNames the extra stream metadata format class names, returned by getStreamMetadataFormat.
param
supportsStandardImageMetadataFormat the value indicating if image metadata can be described by standard metadata format.
param
nativeImageMetadataFormatName the native image metadata format name, returned by getNativeImageMetadataFormatName.
param
nativeImageMetadataFormatClassName the native image metadata format class name, returned by getNativeImageMetadataFormat.
param
extraImageMetadataFormatNames the extra image metadata format names, returned by getExtraImageMetadataFormatNames.
param
extraImageMetadataFormatClassNames the extra image metadata format class names, returned by getImageMetadataFormat.

        super(vendorName, version);

        if (names == null || names.length == 0) {
            throw new NullPointerException("format names array cannot be NULL or empty");
        }

        if (pluginClassName == null) {
            throw new NullPointerException("Plugin class name cannot be NULL");
        }

        // We clone all the arrays to be consistent with the fact that
        // some methods of this class must return clones of the arrays
        // as it is stated in the spec.
        this.names = names.clone();
        this.suffixes = suffixes == null ? null : suffixes.clone();
        this.MIMETypes = MIMETypes == null ? null : MIMETypes.clone();
        this.pluginClassName = pluginClassName;
        this.supportsStandardStreamMetadataFormat = supportsStandardStreamMetadataFormat;
        this.nativeStreamMetadataFormatName = nativeStreamMetadataFormatName;
        this.nativeStreamMetadataFormatClassName = nativeStreamMetadataFormatClassName;

        this.extraStreamMetadataFormatNames = extraStreamMetadataFormatNames == null ? null
                : extraStreamMetadataFormatNames.clone();

        this.extraStreamMetadataFormatClassNames = extraStreamMetadataFormatClassNames == null ? null
                : extraStreamMetadataFormatClassNames.clone();

        this.supportsStandardImageMetadataFormat = supportsStandardImageMetadataFormat;
        this.nativeImageMetadataFormatName = nativeImageMetadataFormatName;
        this.nativeImageMetadataFormatClassName = nativeImageMetadataFormatClassName;

        this.extraImageMetadataFormatNames = extraImageMetadataFormatNames == null ? null
                : extraImageMetadataFormatNames.clone();

        this.extraImageMetadataFormatClassNames = extraImageMetadataFormatClassNames == null ? null
                : extraImageMetadataFormatClassNames.clone();
    
public ImageReaderWriterSpi()
Instantiates a new ImageReaderWriterSpi.

    
Methods Summary
public java.lang.String[]getExtraImageMetadataFormatNames()
Gets an array of strings with the names of additional formats of the image metadata objects produced or consumed by this plug-in.

return
the array of extra image metadata format names.

        return extraImageMetadataFormatNames == null ? null : extraImageMetadataFormatNames.clone();
    
public java.lang.String[]getExtraStreamMetadataFormatNames()
Gets an array of strings with the names of additional formats of the stream metadata objects produced or consumed by this plug-in.

return
the array of extra stream metadata format names.

        return extraStreamMetadataFormatNames == null ? null : extraStreamMetadataFormatNames
                .clone();
    
public java.lang.String[]getFileSuffixes()
Gets an array of strings representing file suffixes associated with the formats that can be used by the ImageReader or ImageWriter implementation of this service provider.

return
the array of file suffixes.

        return suffixes == null ? null : suffixes.clone();
    
public java.lang.String[]getFormatNames()
Gets an array of strings representing names of the formats that can be used by the ImageReader or ImageWriter implementation associated with this service provider.

return
the array of supported format names.

        return names.clone();
    
public javax.imageio.metadata.IIOMetadataFormatgetImageMetadataFormat(java.lang.String formatName)
Gets an IIOMetadataFormat object for the specified image metadata format name.

param
formatName the format name.
return
the IIOMetadataFormat, or null.

        return IIOMetadataUtils.instantiateMetadataFormat(formatName,
                supportsStandardImageMetadataFormat, nativeImageMetadataFormatName,
                nativeImageMetadataFormatClassName, extraImageMetadataFormatNames,
                extraImageMetadataFormatClassNames);
    
public java.lang.String[]getMIMETypes()
Gets an array of strings representing the MIME types of the formats that are supported by the ImageReader or ImageWriter implementation of this service provider.

return
the array MIME types.

        return MIMETypes == null ? null : MIMETypes.clone();
    
public java.lang.StringgetNativeImageMetadataFormatName()
Gets the name of the native image metadata format for this reader/writer, which allows for lossless encoding or decoding of the image metadata with the format.

return
the string with native image metadata format name, or null.

        return nativeImageMetadataFormatName;
    
public java.lang.StringgetNativeStreamMetadataFormatName()
Gets the name of the native stream metadata format for this reader/writer, which allows for lossless encoding or decoding of the stream metadata with the format.

return
the string with native stream metadata format name, or null.

        return nativeStreamMetadataFormatName;
    
public java.lang.StringgetPluginClassName()
Gets the class name of the ImageReader or ImageWriter associated with this service provider.

return
the class name.

        return pluginClassName;
    
public javax.imageio.metadata.IIOMetadataFormatgetStreamMetadataFormat(java.lang.String formatName)
Gets an IIOMetadataFormat object for the specified stream metadata format name.

param
formatName the format name.
return
the IIOMetadataFormat, or null.

        return IIOMetadataUtils.instantiateMetadataFormat(formatName,
                supportsStandardStreamMetadataFormat, nativeStreamMetadataFormatName,
                nativeStreamMetadataFormatClassName, extraStreamMetadataFormatNames,
                extraStreamMetadataFormatClassNames);
    
public booleanisStandardImageMetadataFormatSupported()
Checks if the standard metadata format is supported by the getAsTree and setFromTree methods for the image metadata objects produced or consumed by this reader or writer.

return
true, if standard image metadata format is supported, false otherwise.

        return supportsStandardImageMetadataFormat;
    
public booleanisStandardStreamMetadataFormatSupported()
Checks if the standard metadata format is supported by the getAsTree and setFromTree methods for the stream metadata objects produced or consumed by this reader or writer.

return
true, if standard stream metadata format is supported, false otherwise.

        return supportsStandardStreamMetadataFormat;