PNGMetadataFormat

extends IIOMetadataFormatImpl

java.lang.Object
↳	javax.imageio.metadata.IIOMetadataFormatImpl
	↳	com.sun.imageio.plugins.png.PNGMetadataFormat

Summary

[Expand]

Inherited Constants

From class javax.imageio.metadata.IIOMetadataFormatImpl

From interface javax.imageio.metadata.IIOMetadataFormat

int	CHILD_POLICY_ALL	A constant returned by `getChildPolicy` to indicate that an element must have a single instance of each of its legal child elements, in order.
int	CHILD_POLICY_CHOICE	A constant returned by `getChildPolicy` to indicate that an element must have zero or one children, selected from among its legal child elements.
int	CHILD_POLICY_EMPTY	A constant returned by `getChildPolicy` to indicate that an element may not have any children.
int	CHILD_POLICY_MAX	The largest valid `CHILD_POLICY_*` constant, to be used for range checks.
int	CHILD_POLICY_REPEAT	A constant returned by `getChildPolicy` to indicate that an element must have zero or more instances of its unique legal child element.
int	CHILD_POLICY_SEQUENCE	A constant returned by `getChildPolicy` to indicate that an element must have a sequence of instances of any of its legal child elements.
int	CHILD_POLICY_SOME	A constant returned by `getChildPolicy` to indicate that an element must have zero or one instance of each of its legal child elements, in order.
int	DATATYPE_BOOLEAN	A constant returned by `getAttributeDataType` indicating that the value of an attribute is one of 'true' or 'false'.
int	DATATYPE_DOUBLE	A constant returned by `getAttributeDataType` indicating that the value of an attribute is a string representation of a double-precision decimal floating-point number.
int	DATATYPE_FLOAT	A constant returned by `getAttributeDataType` indicating that the value of an attribute is a string representation of a decimal floating-point number.
int	DATATYPE_INTEGER	A constant returned by `getAttributeDataType` indicating that the value of an attribute is a string representation of an integer.
int	DATATYPE_STRING	A constant returned by `getAttributeDataType` indicating that the value of an attribute is a general Unicode string.
int	VALUE_ARBITRARY	A constant returned by `getAttributeValueType` and `getObjectValueType` to indicate that the attribute or user object may be set a single, arbitrary value.
int	VALUE_ENUMERATION	A constant returned by `getAttributeValueType` and `getObjectValueType` to indicate that the attribute or user object may be set one of a number of enumerated values.
int	VALUE_LIST	A constant returned by `getAttributeValueType` and `getObjectValueType` to indicate that the attribute or user object may be set to a list or array of values.
int	VALUE_NONE	A constant returned by `getObjectValueType` to indicate the absence of a user object.
int	VALUE_RANGE	A constant returned by `getAttributeValueType` and `getObjectValueType` to indicate that the attribute or user object may be set a range of values.
int	VALUE_RANGE_MAX_INCLUSIVE	A constant returned by `getAttributeValueType` and `getObjectValueType` to indicate that the attribute or user object may be set to a range of values.
int	VALUE_RANGE_MAX_INCLUSIVE_MASK	A value that may be or'ed with `VALUE_RANGE` to obtain `VALUE_RANGE_MAX_INCLUSIVE`, and with `VALUE_RANGE_MIN_INCLUSIVE` to obtain `VALUE_RANGE_MIN_MAX_INCLUSIVE`.
int	VALUE_RANGE_MIN_INCLUSIVE	A constant returned by `getAttributeValueType` and `getObjectValueType` to indicate that the attribute or user object may be set to a range of values.
int	VALUE_RANGE_MIN_INCLUSIVE_MASK	A value that may be or'ed with `VALUE_RANGE` to obtain `VALUE_RANGE_MIN_INCLUSIVE`, and with `VALUE_RANGE_MAX_INCLUSIVE` to obtain `VALUE_RANGE_MIN_MAX_INCLUSIVE`.
int	VALUE_RANGE_MIN_MAX_INCLUSIVE	A constant returned by `getAttributeValueType` and `getObjectValueType` to indicate that the attribute or user object may be set a range of values.

Public Methods
boolean	canNodeAppear(String elementName, ImageTypeSpecifier imageType) Returns `true` if the element (and the subtree below it) is allowed to appear in a metadata document for an image of the given type, defined by an `ImageTypeSpecifier`.
synchronized static IIOMetadataFormat	getInstance()

[Expand]

Inherited Methods

From class javax.imageio.metadata.IIOMetadataFormatImpl

void	addAttribute(String elementName, String attrName, int dataType, boolean required, String defaultValue, String minValue, String maxValue, boolean minInclusive, boolean maxInclusive) Adds a new attribute to a previously defined element that will be defined by a range of values.
void	addAttribute(String elementName, String attrName, int dataType, boolean required, String defaultValue) Adds a new attribute to a previously defined element that may be set to an arbitrary value.
void	addAttribute(String elementName, String attrName, int dataType, boolean required, int listMinLength, int listMaxLength) Adds a new attribute to a previously defined element that will be defined by a list of values.
void	addAttribute(String elementName, String attrName, int dataType, boolean required, String defaultValue, List<String> enumeratedValues) Adds a new attribute to a previously defined element that will be defined by a set of enumerated values.
void	addBooleanAttribute(String elementName, String attrName, boolean hasDefaultValue, boolean defaultValue) Adds a new attribute to a previously defined element that will be defined by the enumerated values `TRUE` and `FALSE`, with a datatype of `DATATYPE_BOOLEAN`.
void	addChildElement(String elementName, String parentName) Adds an existing element to the list of legal children for a given parent node type.
void	addElement(String elementName, String parentName, int minChildren, int maxChildren) Adds a new element type to this metadata document format with a child policy of `CHILD_POLICY_REPEAT`.
void	addElement(String elementName, String parentName, int childPolicy) Adds a new element type to this metadata document format with a child policy other than `CHILD_POLICY_REPEAT`.
void	addObjectValue(String elementName, Class<?> classType, int arrayMinLength, int arrayMaxLength) Allows an `Object` reference of a given class type to be stored in nodes implementing the named element.
<T> void	addObjectValue(String elementName, Class<T> classType, boolean required, T defaultValue) Allows an `Object` reference of a given class type to be stored in nodes implementing the named element.
<T extends Object & Comparable<? super T>> void	addObjectValue(String elementName, Class<T> classType, T defaultValue, Comparable<? super T> minValue, Comparable<? super T> maxValue, boolean minInclusive, boolean maxInclusive) Allows an `Object` reference of a given class type to be stored in nodes implementing the named element.
<T> void	addObjectValue(String elementName, Class<T> classType, boolean required, T defaultValue, List<? extends T> enumeratedValues) Allows an `Object` reference of a given class type to be stored in nodes implementing the named element.
abstract boolean	canNodeAppear(String elementName, ImageTypeSpecifier imageType) Returns `true` if the element (and the subtree below it) is allowed to appear in a metadata document for an image of the given type, defined by an `ImageTypeSpecifier`.
int	getAttributeDataType(String elementName, String attrName) Returns one of the constants starting with `DATATYPE_`, indicating the format and interpretation of the value of the given attribute within th enamed element.
String	getAttributeDefaultValue(String elementName, String attrName) Returns the default value of the named attribute, if it is not explictly present within the named element, as a `String`, or `null` if no default value is available.
String	getAttributeDescription(String elementName, String attrName, Locale locale) Returns a `String` containing a description of the named attribute, or `null`.
String[]	getAttributeEnumerations(String elementName, String attrName) Returns an array of `String`s containing the legal enumerated values for the given attribute within the named element.
int	getAttributeListMaxLength(String elementName, String attrName) Returns the maximum number of list items that may be used to define this attribute.
int	getAttributeListMinLength(String elementName, String attrName) Returns the minimum number of list items that may be used to define this attribute.
String	getAttributeMaxValue(String elementName, String attrName) Returns the maximum legal value for the attribute.
String	getAttributeMinValue(String elementName, String attrName) Returns the minimum legal value for the attribute.
String[]	getAttributeNames(String elementName) Returns an array of `String`s listing the names of the attributes that may be associated with the named element.
int	getAttributeValueType(String elementName, String attrName) Returns one of the constants starting with `VALUE_`, indicating whether the values of the given attribute within the named element are arbitrary, constrained to lie within a specified range, constrained to be one of a set of enumerated values, or are a whitespace-separated list of arbitrary values.
String[]	getChildNames(String elementName) Returns an array of `String`s indicating the names of the element which are allowed to be children of the named element, in the order in which they should appear.
int	getChildPolicy(String elementName) Returns one of the constants starting with `CHILD_POLICY_`, indicating the legal pattern of children for the named element.
String	getElementDescription(String elementName, Locale locale) Returns a `String` containing a description of the named element, or `null`.
int	getElementMaxChildren(String elementName) Returns the maximum number of children of the named element with child policy `CHILD_POLICY_REPEAT`.
int	getElementMinChildren(String elementName) Returns the minimum number of children of the named element with child policy `CHILD_POLICY_REPEAT`.
int	getObjectArrayMaxLength(String elementName) Returns the maximum number of array elements that may be used to define the `Object` reference within the named element.
int	getObjectArrayMinLength(String elementName) Returns the minimum number of array elements that may be used to define the `Object` reference within the named element.
Class<?>	getObjectClass(String elementName) Returns the `Class` type of the `Object` reference stored within the element.
Object	getObjectDefaultValue(String elementName) Returns an `Object`s containing the default value for the `Object` reference within the named element.
Object[]	getObjectEnumerations(String elementName) Returns an array of `Object`s containing the legal enumerated values for the `Object` reference within the named element.
Comparable<?>	getObjectMaxValue(String elementName) Returns the maximum legal value for the `Object` reference within the named element.
Comparable<?>	getObjectMinValue(String elementName) Returns the minimum legal value for the `Object` reference within the named element.
int	getObjectValueType(String elementName) Returns one of the enumerated values starting with `VALUE_`, indicating the type of values (enumeration, range, or array) that are allowed for the `Object` reference.
String	getResourceBaseName() Returns the currently set base name for locating `ResourceBundle`s.
String	getRootName() Returns the name of the root element of the format.
static IIOMetadataFormat	getStandardFormatInstance() Returns an `IIOMetadataFormat` object describing the standard, plug-in neutral `javax.imageio_1.0` metadata document format described in the comment of the `javax.imageio.metadata` package.
boolean	isAttributeRequired(String elementName, String attrName) Returns `true` if the named attribute must be present within the named element.
void	removeAttribute(String elementName, String attrName) Removes an attribute from a previously defined element.
void	removeElement(String elementName) Removes an element from the format.
void	removeObjectValue(String elementName) Disallows an `Object` reference from being stored in nodes implementing the named element.
void	setResourceBaseName(String resourceBaseName) Sets a new base name for locating `ResourceBundle`s containing descriptions of elements and attributes for this 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.

From interface javax.imageio.metadata.IIOMetadataFormat

abstract boolean	canNodeAppear(String elementName, ImageTypeSpecifier imageType) Returns `true` if the element (and the subtree below it) is allowed to appear in a metadata document for an image of the given type, defined by an `ImageTypeSpecifier`.
abstract int	getAttributeDataType(String elementName, String attrName) Returns one of the constants starting with `DATATYPE_`, indicating the format and interpretation of the value of the given attribute within th enamed element.
abstract String	getAttributeDefaultValue(String elementName, String attrName) Returns the default value of the named attribute, if it is not explictly present within the named element, as a `String`, or `null` if no default value is available.
abstract String	getAttributeDescription(String elementName, String attrName, Locale locale) Returns a `String` containing a description of the named attribute, or `null`.
abstract String[]	getAttributeEnumerations(String elementName, String attrName) Returns an array of `String`s containing the legal enumerated values for the given attribute within the named element.
abstract int	getAttributeListMaxLength(String elementName, String attrName) Returns the maximum number of list items that may be used to define this attribute.
abstract int	getAttributeListMinLength(String elementName, String attrName) Returns the minimum number of list items that may be used to define this attribute.
abstract String	getAttributeMaxValue(String elementName, String attrName) Returns the maximum legal value for the attribute.
abstract String	getAttributeMinValue(String elementName, String attrName) Returns the minimum legal value for the attribute.
abstract String[]	getAttributeNames(String elementName) Returns an array of `String`s listing the names of the attributes that may be associated with the named element.
abstract int	getAttributeValueType(String elementName, String attrName) Returns one of the constants starting with `VALUE_`, indicating whether the values of the given attribute within the named element are arbitrary, constrained to lie within a specified range, constrained to be one of a set of enumerated values, or are a whitespace-separated list of arbitrary values.
abstract String[]	getChildNames(String elementName) Returns an array of `String`s indicating the names of the element which are allowed to be children of the named element, in the order in which they should appear.
abstract int	getChildPolicy(String elementName) Returns one of the constants starting with `CHILD_POLICY_`, indicating the legal pattern of children for the named element.
abstract String	getElementDescription(String elementName, Locale locale) Returns a `String` containing a description of the named element, or `null`.
abstract int	getElementMaxChildren(String elementName) Returns the maximum number of children of the named element with child policy `CHILD_POLICY_REPEAT`.
abstract int	getElementMinChildren(String elementName) Returns the minimum number of children of the named element with child policy `CHILD_POLICY_REPEAT`.
abstract int	getObjectArrayMaxLength(String elementName) Returns the maximum number of array elements that may be used to define the `Object` reference within the named element.
abstract int	getObjectArrayMinLength(String elementName) Returns the minimum number of array elements that may be used to define the `Object` reference within the named element.
abstract Class<?>	getObjectClass(String elementName) Returns the `Class` type of the `Object` reference stored within the element.
abstract Object	getObjectDefaultValue(String elementName) Returns an `Object`s containing the default value for the `Object` reference within the named element.
abstract Object[]	getObjectEnumerations(String elementName) Returns an array of `Object`s containing the legal enumerated values for the `Object` reference within the named element.
abstract Comparable<?>	getObjectMaxValue(String elementName) Returns the maximum legal value for the `Object` reference within the named element.
abstract Comparable<?>	getObjectMinValue(String elementName) Returns the minimum legal value for the `Object` reference within the named element.
abstract int	getObjectValueType(String elementName) Returns one of the enumerated values starting with `VALUE_`, indicating the type of values (enumeration, range, or array) that are allowed for the `Object` reference.
abstract String	getRootName() Returns the name of the root element of the format.
abstract boolean	isAttributeRequired(String elementName, String attrName) Returns `true` if the named attribute must be present within the named element.

Public Methods

public boolean canNodeAppear (String elementName, ImageTypeSpecifier imageType)

Returns true if the element (and the subtree below it) is allowed to appear in a metadata document for an image of the given type, defined by an ImageTypeSpecifier. For example, a metadata document format might contain an element that describes the primary colors of the image, which would not be allowed when writing a grayscale image.

Parameters

elementName	the name of the element being queried.
imageType	an `ImageTypeSpecifier` indicating the type of the image that will be associated with the metadata.

Returns

true if the node is meaningful for images of the given type.