Summary: Inherited Fields | Methods | Protected Methods | Inherited Methods | [Expand All]

public class

JPEGMetadata

extends IIOMetadata
implements Cloneable

java.lang.Object
↳	javax.imageio.metadata.IIOMetadata
	↳	com.sun.imageio.plugins.jpeg.JPEGMetadata

Class Overview

Metadata for the JPEG plug-in.

Summary

[Expand]

Inherited Fields

From class javax.imageio.metadata.IIOMetadata

protected IIOMetadataController	controller	The `IIOMetadataController` that will be used to provide settings for this `IIOMetadata` object when the `activateController` method is called.
protected IIOMetadataController	defaultController	An `IIOMetadataController` that is suggested for use as the controller for this `IIOMetadata` object.
protected String[]	extraMetadataFormatClassNames	An array of names of classes implementing `IIOMetadataFormat` and representing the metadata formats, other than the standard and native formats, that are supported by this plug-in, initialized to `null` and set via the constructor.
protected String[]	extraMetadataFormatNames	An array of names of formats, other than the standard and native formats, that are supported by this plug-in, initialized to `null` and set via the constructor.
protected String	nativeMetadataFormatClassName	The name of the class implementing `IIOMetadataFormat` and representing the native metadata format, initialized to `null` and set via the constructor.
protected String	nativeMetadataFormatName	The name of the native metadata format for this object, initialized to `null` and set via the constructor.
protected boolean	standardFormatSupported	A boolean indicating whether the concrete subclass supports the standard metadata format, set via the constructor.

Public Methods
Node	getAsTree(String formatName) Returns an XML DOM `Node` object that represents the root of a tree of metadata contained within this object according to the conventions defined by a given metadata format.
boolean	isReadOnly() Returns `true` if this object does not support the `mergeTree`, `setFromTree`, and `reset` methods.
void	mergeTree(String formatName, Node root) Alters the internal state of this `IIOMetadata` object from a tree of XML DOM `Node`s whose syntax is defined by the given metadata format.
void	print()
void	reset() Resets all the data stored in this object to default values, usually to the state this object was in immediately after construction, though the precise semantics are plug-in specific.
void	setFromTree(String formatName, Node root) Sets the internal state of this `IIOMetadata` object from a tree of XML DOM `Node`s whose syntax is defined by the given metadata format.

Protected Methods
Object	clone() Creates and returns a copy of this object.
IIOMetadataNode	getStandardChromaNode() Returns an `IIOMetadataNode` representing the chroma information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardCompressionNode() Returns an `IIOMetadataNode` representing the compression information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardDimensionNode() Returns an `IIOMetadataNode` representing the dimension information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardTextNode() Returns an `IIOMetadataNode` representing the textual information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardTransparencyNode() Returns an `IIOMetadataNode` representing the transparency information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.

[Expand]

Inherited Methods

From class javax.imageio.metadata.IIOMetadata

boolean	activateController() Activates the installed `IIOMetadataController` for this `IIOMetadata` object and returns the resulting value.
abstract Node	getAsTree(String formatName) Returns an XML DOM `Node` object that represents the root of a tree of metadata contained within this object according to the conventions defined by a given metadata format.
IIOMetadataController	getController() Returns whatever `IIOMetadataController` is currently installed.
IIOMetadataController	getDefaultController() Returns the default `IIOMetadataController`, if there is one, regardless of the currently installed controller.
String[]	getExtraMetadataFormatNames() Returns an array of `String`s containing the names of additional metadata formats, other than the native and standard formats, recognized by this plug-in's `getAsTree`, `setFromTree`, and `mergeTree` methods.
IIOMetadataFormat	getMetadataFormat(String formatName) Returns an `IIOMetadataFormat` object describing the given metadata format, or `null` if no description is available.
String[]	getMetadataFormatNames() Returns an array of `String`s containing the names of all metadata formats, including the native and standard formats, recognized by this plug-in's `getAsTree`, `setFromTree`, and `mergeTree` methods.
String	getNativeMetadataFormatName() Returns the name of the "native" metadata format for this plug-in, which typically allows for lossless encoding and transmission of the metadata stored in the format handled by this plug-in.
IIOMetadataNode	getStandardChromaNode() Returns an `IIOMetadataNode` representing the chroma information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardCompressionNode() Returns an `IIOMetadataNode` representing the compression information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardDataNode() Returns an `IIOMetadataNode` representing the data format information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardDimensionNode() Returns an `IIOMetadataNode` representing the dimension information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardDocumentNode() Returns an `IIOMetadataNode` representing the document information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardTextNode() Returns an `IIOMetadataNode` representing the textual information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardTileNode() Returns an `IIOMetadataNode` representing the tiling information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardTransparencyNode() Returns an `IIOMetadataNode` representing the transparency information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
final IIOMetadataNode	getStandardTree() A utility method to return a tree of `IIOMetadataNode`s representing the metadata contained within this object according to the conventions of the standard `javax_imageio_1.0` metadata format.
boolean	hasController() Returns `true` if there is a controller installed for this `IIOMetadata` object.
abstract boolean	isReadOnly() Returns `true` if this object does not support the `mergeTree`, `setFromTree`, and `reset` methods.
boolean	isStandardMetadataFormatSupported() Returns `true` if the standard metadata format is supported by `getMetadataFormat`, `getAsTree`, `setFromTree`, and `mergeTree`.
abstract void	mergeTree(String formatName, Node root) Alters the internal state of this `IIOMetadata` object from a tree of XML DOM `Node`s whose syntax is defined by the given metadata format.
abstract void	reset() Resets all the data stored in this object to default values, usually to the state this object was in immediately after construction, though the precise semantics are plug-in specific.
void	setController(IIOMetadataController controller) Sets the `IIOMetadataController` to be used to provide settings for this `IIOMetadata` object when the `activateController` method is called, overriding any default controller.
void	setFromTree(String formatName, Node root) Sets the internal state of this `IIOMetadata` object from a tree of XML DOM `Node`s whose syntax is defined by the given metadata format.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

Public Methods

public Node getAsTree (String formatName)

Returns an XML DOM Node object that represents the root of a tree of metadata contained within this object according to the conventions defined by a given metadata format.

The names of the available metadata formats may be queried using the getMetadataFormatNames method.

Parameters

formatName	the desired metadata format.

Returns

an XML DOM Node object forming the root of a tree.

public boolean isReadOnly ()

Returns true if this object does not support the mergeTree, setFromTree, and reset methods.

Returns

true if this IIOMetadata object cannot be modified.

public void mergeTree (String formatName, Node root)

Alters the internal state of this IIOMetadata object from a tree of XML DOM Nodes whose syntax is defined by the given metadata format. The previous state is altered only as necessary to accomodate the nodes that are present in the given tree. If the tree structure or contents are invalid, an IIOInvalidTreeException will be thrown.

As the semantics of how a tree or subtree may be merged with another tree are completely format-specific, plug-in authors may implement this method in whatever manner is most appropriate for the format, including simply replacing all existing state with the contents of the given tree.

Parameters

formatName	the desired metadata format.
root	an XML DOM `Node` object forming the root of a tree.

Throws

IIOInvalidTreeException

public void print ()

public void reset ()

Resets all the data stored in this object to default values, usually to the state this object was in immediately after construction, though the precise semantics are plug-in specific. Note that there are many possible default values, depending on how the object was created.

public void setFromTree (String formatName, Node root)

Sets the internal state of this IIOMetadata object from a tree of XML DOM Nodes whose syntax is defined by the given metadata format. The previous state is discarded. If the tree's structure or contents are invalid, an IIOInvalidTreeException will be thrown.

The default implementation calls reset followed by mergeTree(formatName, root).

Parameters

formatName	the desired metadata format.
root	an XML DOM `Node` object forming the root of a tree.

Throws

IIOInvalidTreeException

Protected Methods

protected Object clone ()

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x

will be true, and that the expression:

 x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

 x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.

The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.

Returns

a clone of this instance.

protected IIOMetadataNode getStandardChromaNode ()

Returns an IIOMetadataNode representing the chroma information of the standard javax_imageio_1.0 metadata format, or null if no such information is available. This method is intended to be called by the utility routine getStandardTree.