< prev index next >
src/java.desktop/share/classes/javax/imageio/spi/ImageReaderWriterSpi.java
Print this page
@@ -36,183 +36,183 @@
import javax.imageio.metadata.IIOMetadataFormatImpl;
import javax.imageio.stream.ImageInputStream;
/**
* A superclass containing instance variables and methods common to
- * <code>ImageReaderSpi</code> and <code>ImageWriterSpi</code>.
+ * {@code ImageReaderSpi} and {@code ImageWriterSpi}.
*
* @see IIORegistry
* @see ImageReaderSpi
* @see ImageWriterSpi
*
*/
public abstract class ImageReaderWriterSpi extends IIOServiceProvider {
/**
* An array of strings to be returned from
- * <code>getFormatNames</code>, initially <code>null</code>.
- * Constructors should set this to a non-<code>null</code> value.
+ * {@code getFormatNames}, initially {@code null}.
+ * Constructors should set this to a non-{@code null} value.
*/
protected String[] names = null;
/**
* An array of strings to be returned from
- * <code>getFileSuffixes</code>, initially <code>null</code>.
+ * {@code getFileSuffixes}, initially {@code null}.
*/
protected String[] suffixes = null;
/**
* An array of strings to be returned from
- * <code>getMIMETypes</code>, initially <code>null</code>.
+ * {@code getMIMETypes}, initially {@code null}.
*/
protected String[] MIMETypes = null;
/**
- * A <code>String</code> containing the name of the associated
- * plug-in class, initially <code>null</code>.
+ * A {@code String} containing the name of the associated
+ * plug-in class, initially {@code null}.
*/
protected String pluginClassName = null;
/**
* A boolean indicating whether this plug-in supports the
* standard metadata format for stream metadata, initially
- * <code>false</code>.
+ * {@code false}.
*/
protected boolean supportsStandardStreamMetadataFormat = false;
/**
- * A <code>String</code> containing the name of the native stream
+ * A {@code String} containing the name of the native stream
* metadata format supported by this plug-in, initially
- * <code>null</code>.
+ * {@code null}.
*/
protected String nativeStreamMetadataFormatName = null;
/**
- * A <code>String</code> containing the class name of the native
+ * A {@code String} containing the class name of the native
* stream metadata format supported by this plug-in, initially
- * <code>null</code>.
+ * {@code null}.
*/
protected String nativeStreamMetadataFormatClassName = null;
/**
- * An array of <code>String</code>s containing the names of any
+ * An array of {@code String}s containing the names of any
* additional stream metadata formats supported by this plug-in,
- * initially <code>null</code>.
+ * initially {@code null}.
*/
protected String[] extraStreamMetadataFormatNames = null;
/**
- * An array of <code>String</code>s containing the class names of
+ * An array of {@code String}s containing the class names of
* any additional stream metadata formats supported by this plug-in,
- * initially <code>null</code>.
+ * initially {@code null}.
*/
protected String[] extraStreamMetadataFormatClassNames = null;
/**
* A boolean indicating whether this plug-in supports the
* standard metadata format for image metadata, initially
- * <code>false</code>.
+ * {@code false}.
*/
protected boolean supportsStandardImageMetadataFormat = false;
/**
- * A <code>String</code> containing the name of the
+ * A {@code String} containing the name of the
* native stream metadata format supported by this plug-in,
- * initially <code>null</code>.
+ * initially {@code null}.
*/
protected String nativeImageMetadataFormatName = null;
/**
- * A <code>String</code> containing the class name of the
+ * A {@code String} containing the class name of the
* native stream metadata format supported by this plug-in,
- * initially <code>null</code>.
+ * initially {@code null}.
*/
protected String nativeImageMetadataFormatClassName = null;
/**
- * An array of <code>String</code>s containing the names of any
+ * An array of {@code String}s containing the names of any
* additional image metadata formats supported by this plug-in,
- * initially <code>null</code>.
+ * initially {@code null}.
*/
protected String[] extraImageMetadataFormatNames = null;
/**
- * An array of <code>String</code>s containing the class names of
+ * An array of {@code String}s containing the class names of
* any additional image metadata formats supported by this
- * plug-in, initially <code>null</code>.
+ * plug-in, initially {@code null}.
*/
protected String[] extraImageMetadataFormatClassNames = null;
/**
- * Constructs an <code>ImageReaderWriterSpi</code> with a given
+ * Constructs an {@code ImageReaderWriterSpi} with a given
* set of values.
*
- * @param vendorName the vendor name, as a non-<code>null</code>
- * <code>String</code>.
- * @param version a version identifier, as a non-<code>null</code>
- * <code>String</code>.
- * @param names a non-<code>null</code> array of
- * <code>String</code>s indicating the format names. At least one
+ * @param vendorName the vendor name, as a non-{@code null}
+ * {@code String}.
+ * @param version a version identifier, as a non-{@code null}
+ * {@code String}.
+ * @param names a non-{@code null} array of
+ * {@code String}s indicating the format names. At least one
* entry must be present.
- * @param suffixes an array of <code>String</code>s indicating the
+ * @param suffixes an array of {@code String}s indicating the
* common file suffixes. If no suffixes are defined,
- * <code>null</code> should be supplied. An array of length 0
- * will be normalized to <code>null</code>.
- * @param MIMETypes an array of <code>String</code>s indicating
+ * {@code null} should be supplied. An array of length 0
+ * will be normalized to {@code null}.
+ * @param MIMETypes an array of {@code String}s indicating
* the format's MIME types. If no MIME types are defined,
- * <code>null</code> should be supplied. An array of length 0
- * will be normalized to <code>null</code>.
+ * {@code null} should be supplied. An array of length 0
+ * will be normalized to {@code null}.
* @param pluginClassName the fully-qualified name of the
- * associated <code>ImageReader</code> or <code>ImageWriter</code>
- * class, as a non-<code>null</code> <code>String</code>.
+ * associated {@code ImageReader} or {@code ImageWriter}
+ * class, as a non-{@code null String}.
* @param supportsStandardStreamMetadataFormat a
- * <code>boolean</code> that indicates whether a stream metadata
+ * {@code boolean} that indicates whether a stream metadata
* object can use trees described by the standard metadata format.
* @param nativeStreamMetadataFormatName a
- * <code>String</code>, or <code>null</code>, to be returned from
- * <code>getNativeStreamMetadataFormatName</code>.
+ * {@code String}, or {@code null}, to be returned from
+ * {@code getNativeStreamMetadataFormatName}.
* @param nativeStreamMetadataFormatClassName a
- * <code>String</code>, or <code>null</code>, to be used to instantiate
+ * {@code String}, or {@code null}, to be used to instantiate
* a metadata format object to be returned from
- * <code>getNativeStreamMetadataFormat</code>.
+ * {@code getNativeStreamMetadataFormat}.
* @param extraStreamMetadataFormatNames an array of
- * <code>String</code>s, or <code>null</code>, to be returned from
- * <code>getExtraStreamMetadataFormatNames</code>. An array of length
- * 0 is normalized to <code>null</code>.
+ * {@code String}s, or {@code null}, to be returned from
+ * {@code getExtraStreamMetadataFormatNames}. An array of length
+ * 0 is normalized to {@code null}.
* @param extraStreamMetadataFormatClassNames an array of
- * <code>String</code>s, or <code>null</code>, to be used to instantiate
+ * {@code String}s, or {@code null}, to be used to instantiate
* a metadata format object to be returned from
- * <code>getStreamMetadataFormat</code>. An array of length
- * 0 is normalized to <code>null</code>.
+ * {@code getStreamMetadataFormat}. An array of length
+ * 0 is normalized to {@code null}.
* @param supportsStandardImageMetadataFormat a
- * <code>boolean</code> that indicates whether an image metadata
+ * {@code boolean} that indicates whether an image metadata
* object can use trees described by the standard metadata format.
* @param nativeImageMetadataFormatName a
- * <code>String</code>, or <code>null</code>, to be returned from
- * <code>getNativeImageMetadataFormatName</code>.
+ * {@code String}, or {@code null}, to be returned from
+ * {@code getNativeImageMetadataFormatName}.
* @param nativeImageMetadataFormatClassName a
- * <code>String</code>, or <code>null</code>, to be used to instantiate
+ * {@code String}, or {@code null}, to be used to instantiate
* a metadata format object to be returned from
- * <code>getNativeImageMetadataFormat</code>.
+ * {@code getNativeImageMetadataFormat}.
* @param extraImageMetadataFormatNames an array of
- * <code>String</code>s to be returned from
- * <code>getExtraImageMetadataFormatNames</code>. An array of length 0
- * is normalized to <code>null</code>.
+ * {@code String}s to be returned from
+ * {@code getExtraImageMetadataFormatNames}. An array of length 0
+ * is normalized to {@code null}.
* @param extraImageMetadataFormatClassNames an array of
- * <code>String</code>s, or <code>null</code>, to be used to instantiate
+ * {@code String}s, or {@code null}, to be used to instantiate
* a metadata format object to be returned from
- * <code>getImageMetadataFormat</code>. An array of length
- * 0 is normalized to <code>null</code>.
+ * {@code getImageMetadataFormat}. An array of length
+ * 0 is normalized to {@code null}.
*
- * @exception IllegalArgumentException if <code>vendorName</code>
- * is <code>null</code>.
- * @exception IllegalArgumentException if <code>version</code>
- * is <code>null</code>.
- * @exception IllegalArgumentException if <code>names</code>
- * is <code>null</code> or has length 0.
- * @exception IllegalArgumentException if <code>pluginClassName</code>
- * is <code>null</code>.
+ * @exception IllegalArgumentException if {@code vendorName}
+ * is {@code null}.
+ * @exception IllegalArgumentException if {@code version}
+ * is {@code null}.
+ * @exception IllegalArgumentException if {@code names}
+ * is {@code null} or has length 0.
+ * @exception IllegalArgumentException if {@code pluginClassName}
+ * is {@code null}.
*/
public ImageReaderWriterSpi(String vendorName,
String version,
String[] names,
String[] suffixes,
@@ -285,113 +285,113 @@
extraImageMetadataFormatClassNames.clone();
}
}
/**
- * Constructs a blank <code>ImageReaderWriterSpi</code>. It is up
+ * Constructs a blank {@code 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 ImageReaderWriterSpi() {
}
/**
- * Returns an array of <code>String</code>s containing
+ * Returns an array of {@code String}s containing
* human-readable names for the formats that are generally usable
- * by the <code>ImageReader</code> or <code>ImageWriter</code>
+ * by the {@code ImageReader} or {@code ImageWriter}
* implementation associated with this service provider. For
- * example, a single <code>ImageReader</code> might be able to
+ * example, a single {@code ImageReader} might be able to
* process both PBM and PNM files.
*
- * @return a non-<code>null</code> array of <code>String</code>s
+ * @return a non-{@code null} array of {@code String}s
* or length at least 1 containing informal format names
* associated with this reader or writer.
*/
public String[] getFormatNames() {
return names.clone();
}
/**
- * Returns an array of <code>String</code>s containing a list of
+ * Returns an array of {@code String}s containing a list of
* file suffixes associated with the formats that are generally
- * usable by the <code>ImageReader</code> or
- * <code>ImageWriter</code> implementation associated with this
+ * usable by the {@code ImageReader} or
+ * {@code ImageWriter} implementation associated with this
* service provider. For example, a single
- * <code>ImageReader</code> might be able to process files with
+ * {@code 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,
- * <code>null</code> will be returned.
+ * {@code null} will be returned.
*
* <p> 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.
*
- * @return an array of <code>String</code>s or length at least 1
+ * @return an array of {@code String}s or length at least 1
* containing common file suffixes associated with this reader or
- * writer, or <code>null</code>.
+ * writer, or {@code null}.
*/
public String[] getFileSuffixes() {
return suffixes == null ? null : suffixes.clone();
}
/**
- * Returns an array of <code>String</code>s containing a list of
+ * Returns an array of {@code String}s containing a list of
* MIME types associated with the formats that are generally
- * usable by the <code>ImageReader</code> or
- * <code>ImageWriter</code> implementation associated with this
+ * usable by the {@code ImageReader} or
+ * {@code ImageWriter} implementation associated with this
* service provider.
*
* <p> 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 <code>image/x-pbm</code> and
- * <code>image/x-portable-bitmap</code>. Some file formats have
+ * names will be required, such as {@code image/x-pbm} and
+ * {@code image/x-portable-bitmap}. Some file formats have
* official MIME types but may sometimes be referred to using
* their previous unofficial designations, such as
- * <code>image/x-png</code> instead of the official
- * <code>image/png</code>. Finally, a single service provider may
+ * {@code image/x-png} instead of the official
+ * {@code image/png}. Finally, a single service provider may
* be capable of parsing multiple distinct types from the MIME
- * point of view, for example <code>image/x-xbitmap</code> and
- * <code>image/x-xpixmap</code>.
+ * point of view, for example {@code image/x-xbitmap} and
+ * {@code image/x-xpixmap}.
*
* <p> 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.
*
- * @return an array of <code>String</code>s or length at least 1
+ * @return an array of {@code String}s or length at least 1
* containing MIME types associated with this reader or writer, or
- * <code>null</code>.
+ * {@code null}.
*/
public String[] getMIMETypes() {
return MIMETypes == null ? null : MIMETypes.clone();
}
/**
* Returns the fully-qualified class name of the
- * <code>ImageReader</code> or <code>ImageWriter</code> plug-in
+ * {@code ImageReader} or {@code ImageWriter} plug-in
* associated with this service provider.
*
- * @return the class name, as a non-<code>null</code>
- * <code>String</code>.
+ * @return the class name, as a non-{@code null}
+ * {@code String}.
*/
public String getPluginClassName() {
return pluginClassName;
}
/**
- * Returns <code>true</code> if the standard metadata format is
+ * Returns {@code true} if the standard metadata format is
* among the document formats recognized by the
- * <code>getAsTree</code> and <code>setFromTree</code> methods on
+ * {@code getAsTree} and {@code setFromTree} methods on
* the stream metadata objects produced or consumed by this
* plug-in.
*
- * @return <code>true</code> if the standard format is supported
+ * @return {@code true} if the standard format is supported
* for stream metadata.
*/
public boolean isStandardStreamMetadataFormatSupported() {
return supportsStandardStreamMetadataFormat;
}
@@ -399,29 +399,29 @@
/**
* 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,
- * <code>null</code>will be returned.
+ * {@code null} will be returned.
*
* <p> The default implementation returns the
- * <code>nativeStreamMetadataFormatName</code> instance variable,
+ * {@code nativeStreamMetadataFormatName} instance variable,
* which is typically set by the constructor.
*
* @return the name of the native stream metadata format, or
- * <code>null</code>.
+ * {@code null}.
*
*/
public String getNativeStreamMetadataFormatName() {
return nativeStreamMetadataFormatName;
}
/**
- * Returns an array of <code>String</code>s containing the names
+ * Returns an array of {@code String}s containing the names
* of additional document formats, other than the native and
* standard formats, recognized by the
- * <code>getAsTree</code> and <code>setFromTree</code> methods on
+ * {@code getAsTree} and {@code setFromTree} methods on
* the stream metadata objects produced or consumed by this
* plug-in.
*
* <p> If the plug-in does not handle metadata, null should be
* returned.
@@ -430,14 +430,14 @@
* images being read or written; this method should indicate all
* the additional formats supported by the plug-in under any
* circumstances.
*
* <p> The default implementation returns a clone of the
- * <code>extraStreamMetadataFormatNames</code> instance variable,
+ * {@code extraStreamMetadataFormatNames} instance variable,
* which is typically set by the constructor.
*
- * @return an array of <code>String</code>s, or null.
+ * @return an array of {@code String}s, or null.
*
* @see IIOMetadata#getMetadataFormatNames
* @see #getExtraImageMetadataFormatNames
* @see #getNativeStreamMetadataFormatName
*/
@@ -445,17 +445,17 @@
return extraStreamMetadataFormatNames == null ?
null : extraStreamMetadataFormatNames.clone();
}
/**
- * Returns <code>true</code> if the standard metadata format is
+ * Returns {@code true} if the standard metadata format is
* among the document formats recognized by the
- * <code>getAsTree</code> and <code>setFromTree</code> methods on
+ * {@code getAsTree} and {@code setFromTree} methods on
* the image metadata objects produced or consumed by this
* plug-in.
*
- * @return <code>true</code> if the standard format is supported
+ * @return {@code true} if the standard format is supported
* for image metadata.
*/
public boolean isStandardImageMetadataFormatSupported() {
return supportsStandardImageMetadataFormat;
}
@@ -463,30 +463,30 @@
/**
* 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,
- * <code>null</code>will be returned.
+ * {@code null} will be returned.
*
* <p> The default implementation returns the
- * <code>nativeImageMetadataFormatName</code> instance variable,
+ * {@code nativeImageMetadataFormatName} instance variable,
* which is typically set by the constructor.
*
* @return the name of the native image metadata format, or
- * <code>null</code>.
+ * {@code null}.
*
* @see #getExtraImageMetadataFormatNames
*/
public String getNativeImageMetadataFormatName() {
return nativeImageMetadataFormatName;
}
/**
- * Returns an array of <code>String</code>s containing the names
+ * Returns an array of {@code String}s containing the names
* of additional document formats, other than the native and
* standard formats, recognized by the
- * <code>getAsTree</code> and <code>setFromTree</code> methods on
+ * {@code getAsTree} and {@code setFromTree} methods on
* the image metadata objects produced or consumed by this
* plug-in.
*
* <p> If the plug-in does not handle image metadata, null should
* be returned.
@@ -494,14 +494,14 @@
* <p> 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.
*
* <p> The default implementation returns a clone of the
- * <code>extraImageMetadataFormatNames</code> instance variable,
+ * {@code extraImageMetadataFormatNames} instance variable,
* which is typically set by the constructor.
*
- * @return an array of <code>String</code>s, or null.
+ * @return an array of {@code String}s, or null.
*
* @see IIOMetadata#getMetadataFormatNames
* @see #getExtraStreamMetadataFormatNames
* @see #getNativeImageMetadataFormatName
*/
@@ -509,23 +509,23 @@
return extraImageMetadataFormatNames == null ?
null : extraImageMetadataFormatNames.clone();
}
/**
- * Returns an <code>IIOMetadataFormat</code> object describing the
- * given stream metadata format, or <code>null</code> if no
+ * Returns an {@code IIOMetadataFormat} object describing the
+ * given stream metadata format, or {@code 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
- * <code>getExtraStreamMetadataFormatNames</code>.
+ * {@code getExtraStreamMetadataFormatNames}.
*
* @param formatName the desired stream metadata format.
*
- * @return an <code>IIOMetadataFormat</code> object.
+ * @return an {@code IIOMetadataFormat} object.
*
- * @exception IllegalArgumentException if <code>formatName</code>
- * is <code>null</code> or is not a supported name.
+ * @exception IllegalArgumentException if {@code formatName}
+ * is {@code null} or is not a supported name.
*/
public IIOMetadataFormat getStreamMetadataFormat(String formatName) {
return getMetadataFormat(formatName,
supportsStandardStreamMetadataFormat,
nativeStreamMetadataFormatName,
@@ -533,23 +533,23 @@
extraStreamMetadataFormatNames,
extraStreamMetadataFormatClassNames);
}
/**
- * Returns an <code>IIOMetadataFormat</code> object describing the
- * given image metadata format, or <code>null</code> if no
+ * Returns an {@code IIOMetadataFormat} object describing the
+ * given image metadata format, or {@code 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
- * <code>getExtraImageMetadataFormatNames</code>.
+ * {@code getExtraImageMetadataFormatNames}.
*
* @param formatName the desired image metadata format.
*
- * @return an <code>IIOMetadataFormat</code> object.
+ * @return an {@code IIOMetadataFormat} object.
*
- * @exception IllegalArgumentException if <code>formatName</code>
- * is <code>null</code> or is not a supported name.
+ * @exception IllegalArgumentException if {@code formatName}
+ * is {@code null} or is not a supported name.
*/
public IIOMetadataFormat getImageMetadataFormat(String formatName) {
return getMetadataFormat(formatName,
supportsStandardImageMetadataFormat,
nativeImageMetadataFormatName,
< prev index next >