IIOMetadataFormatImpl JDK 1.6)

Methods

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

Adds a new attribute to a previously defined element that will
be defined by a list of values.
Parameters:
- elementName - the name of the element.
- attrName - the name of the attribute being added.
- dataType - the data type (string format) of the attribute, one of the DATATYPE_* constants.
- required - true if the attribute must be present.
- listMinLength - the smallest legal number of list items.
- listMaxLength - the largest legal number of list items.
Throws:
- IllegalArgumentException - if elementName is null, or is not a legal element name for this format.
- IllegalArgumentException - if attrName is null.
- IllegalArgumentException - if dataType is not one of the predefined constants.
- IllegalArgumentException - if listMinLength is negative or larger than listMaxLength.

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

Adds a new attribute to a previously defined element that may
be set to an arbitrary value.
Parameters:
- elementName - the name of the element.
- attrName - the name of the attribute being added.
- dataType - the data type (string format) of the attribute, one of the DATATYPE_* constants.
- required - true if the attribute must be present.
- defaultValue - the default value for the attribute, or null.
Throws:
- IllegalArgumentException - if elementName is null, or is not a legal element name for this format.
- IllegalArgumentException - if attrName is null.
- IllegalArgumentException - if dataType is not one of the predefined constants.

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

Adds a new attribute to a previously defined element that will
be defined by a set of enumerated values.
Parameters:
- elementName - the name of the element.
- attrName - the name of the attribute being added.
- dataType - the data type (string format) of the attribute, one of the DATATYPE_* constants.
- required - true if the attribute must be present.
- defaultValue - the default value for the attribute, or null.
- enumeratedValues - a List of Strings containing the legal values for the attribute.
Throws:
- IllegalArgumentException - if elementName is null, or is not a legal element name for this format.
- IllegalArgumentException - if attrName is null.
- IllegalArgumentException - if dataType is not one of the predefined constants.
- IllegalArgumentException - if enumeratedValues is null.
- IllegalArgumentException - if enumeratedValues does not contain at least one entry.
- IllegalArgumentException - if enumeratedValues contains an element that is not a String or is null.

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

Adds a new attribute to a previously defined element that will
be defined by a range of values.
Parameters:
- elementName - the name of the element.
- attrName - the name of the attribute being added.
- dataType - the data type (string format) of the attribute, one of the DATATYPE_* constants.
- required - true if the attribute must be present.
- defaultValue - the default value for the attribute, or null.
- minValue - the smallest (inclusive or exclusive depending on the value of minInclusive) legal value for the attribute, as a String.
- maxValue - the largest (inclusive or exclusive depending on the value of minInclusive) legal value for the attribute, as a String.
- minInclusive - true if minValue is inclusive.
- maxInclusive - true if maxValue is inclusive.
Throws:
- IllegalArgumentException - if elementName is null, or is not a legal element name for this format.
- IllegalArgumentException - if attrName is null.
- IllegalArgumentException - if dataType is not one of the predefined constants.

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

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.
Parameters:
- elementName - the name of the element.
- attrName - the name of the attribute being added.
- hasDefaultValue - true if a default value should be present.
- defaultValue - the default value for the attribute as a boolean, ignored if hasDefaultValue is false.
Throws:
- IllegalArgumentException - if elementName is null, or is not a legal element name for this format.
- IllegalArgumentException - if attrName is null.

protected void addChildElement (String elementName, String parentName)

Adds an existing element to the list of legal children for a given parent node type.

Adds an existing element to the list of legal children for a
given parent node type.
Parameters:
- parentName - the name of the element that will be the new parent of the element.
- elementName - the name of the element to be addded as a child.
Throws:
- IllegalArgumentException - if elementName is null, or is not a legal element name for this format.
- IllegalArgumentException - if parentName is null, or is not a legal element name for this format.

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

Adds a new element type to this metadata document format with a
child policy other than CHILD_POLICY_REPEAT.
Parameters:
- elementName - the name of the new element.
- parentName - the name of the element that will be the parent of the new element.
- childPolicy - one of the CHILD_POLICY_* constants, other than CHILD_POLICY_REPEAT, indicating the child policy of the new element.
Throws:
- IllegalArgumentException - if parentName is null, or is not a legal element name for this format.
- IllegalArgumentException - if childPolicy is not one of the predefined constants.

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

Adds a new element type to this metadata document format with a
child policy of CHILD_POLICY_REPEAT.
Parameters:
- elementName - the name of the new element.
- parentName - the name of the element that will be the parent of the new element.
- minChildren - the minimum number of children of the node.
- maxChildren - the maximum number of children of the node.
Throws:
- IllegalArgumentException - if parentName is null, or is not a legal element name for this format.
- IllegalArgumentException - if minChildren is negative or larger than maxChildren.

protected void addObjectValue (String elementName, Class<Object> classType, int arrayMinLength, int arrayMaxLength)

Allows an Object reference of a given class type to be stored in nodes implementing the named element.

Allows an Object reference of a given class type to be stored in nodes implementing the named element. The value of the Object must an array of objects of class type given by classType, with at least arrayMinLength and at most arrayMaxLength elements.

If an Object reference was previously allowed, the previous settings are overwritten.
Parameters:
- elementName - the name of the element.
- classType - a Class variable indicating the legal class type for the object value.
- arrayMinLength - the smallest legal length for the array.
- arrayMaxLength - the largest legal length for the array.
Throws:
- IllegalArgumentException - if elementName is not a legal element name for this format.

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

Allows an Object reference of a given class type to be stored in nodes implementing the named element. The value of the Object is unconstrained other than by its class type.

protected void addObjectValue (String elementName, Class< T> classType, boolean required, T defaultValue, List<Object> enumeratedValues)

Allows an Object reference of a given class type to be stored in nodes implementing the named element.

Allows an Object reference of a given class type to be stored in nodes implementing the named element. The value of the Object must be one of the values given by enumeratedValues.

If an Object reference was previously allowed, the previous settings are overwritten.
Parameters:
- elementName - the name of the element.
- classType - a Class variable indicating the legal class type for the object value.
- required - true if an object value must be present.
- defaultValue - the default value for the Object reference, or null.
- enumeratedValues - a List of Objects containing the legal values for the object reference.
Throws:
- IllegalArgumentException - if elementName is null, or is not a legal element name for this format.
- IllegalArgumentException - if enumeratedValues is null.
- IllegalArgumentException - if enumeratedValues does not contain at least one entry.
- IllegalArgumentException - if enumeratedValues contains an element that is not an instance of the class type denoted by classType or is null.

protected void addObjectValue (String elementName, Class< T> classType, T defaultValue, Comparable<Object> minValue, Comparable<Object> maxValue, boolean minInclusive, boolean maxInclusive)

Allows an Object reference of a given class type to be stored in nodes implementing the named element.

Allows an Object reference of a given class type to be stored in nodes implementing the named element. The value of the Object must be within the range given by minValue and maxValue. Furthermore, the class type must implement the Comparable interface.

If an Object reference was previously allowed, the previous settings are overwritten.
Parameters:
- elementName - the name of the element.
- classType - a Class variable indicating the legal class type for the object value.
- defaultValue - the default value for the
- minValue - the smallest (inclusive or exclusive depending on the value of minInclusive) legal value for the object value, as a String.
- maxValue - the largest (inclusive or exclusive depending on the value of minInclusive) legal value for the object value, as a String.
- minInclusive - true if minValue is inclusive.
- maxInclusive - true if maxValue is inclusive.
Throws:
- IllegalArgumentException - if elementName is null, or is not a legal element name for this format.

publicabstract boolean canNodeAppear (String elementName, ImageTypeSpecifier imageType) [Specified in IIOMetadataFormat]

public int getAttributeDataType (String elementName, String attrName) [Specified in IIOMetadataFormat]

public String getAttributeDefaultValue (String elementName, String attrName) [Specified in IIOMetadataFormat]

public String getAttributeDescription (String elementName, String attrName, Locale locale) [Specified in IIOMetadataFormat]

Returns a String containing a description of the named attribute, or null.

Returns a String containing a description of the named attribute, or null. The desciption will be localized for the supplied Locale if possible.

The default implementation will first locate a ResourceBundle using the current resource base name set by setResourceBaseName and the supplied Locale, using the fallback mechanism described in the comments for ResourceBundle.getBundle. If a ResourceBundle is found, the element name followed by a "/" character followed by the attribute name (elementName + "/" + attrName) will be used as a key to its getString method, and the result returned. If no ResourceBundle is found, or no such key is present, null will be returned.

If locale is null, the current default Locale returned by Locale.getLocale will be used.
Returns: the attribute description.
Parameters:
- elementName - the name of the element.
- attrName - the name of the attribute.
- locale - the Locale for which localization will be attempted, or null.
Throws:
- IllegalArgumentException - if elementName is null, or is not a legal element name for this format.
- IllegalArgumentException - if attrName is null or is not a legal attribute name for this element.
See Also: IIOMetadataFormatImpl.setResourceBaseName(java.lang.String),

public String getAttributeEnumerations (String elementName, String attrName) [Specified in IIOMetadataFormat]

public int getAttributeListMaxLength (String elementName, String attrName) [Specified in IIOMetadataFormat]

public int getAttributeListMinLength (String elementName, String attrName) [Specified in IIOMetadataFormat]

public String getAttributeMaxValue (String elementName, String attrName) [Specified in IIOMetadataFormat]

public String getAttributeMinValue (String elementName, String attrName) [Specified in IIOMetadataFormat]

public String getAttributeNames (String elementName) [Specified in IIOMetadataFormat]

public int getAttributeValueType (String elementName, String attrName) [Specified in IIOMetadataFormat]

public String getChildNames (String elementName) [Specified in IIOMetadataFormat]

public int getChildPolicy (String elementName) [Specified in IIOMetadataFormat]

public String getElementDescription (String elementName, Locale locale) [Specified in IIOMetadataFormat]

Returns a String containing a description of the named element, or null.

Returns a String containing a description of the named element, or null. The desciption will be localized for the supplied Locale if possible.

The default implementation will first locate a ResourceBundle using the current resource base name set by setResourceBaseName and the supplied Locale, using the fallback mechanism described in the comments for ResourceBundle.getBundle. If a ResourceBundle is found, the element name will be used as a key to its getString method, and the result returned. If no ResourceBundle is found, or no such key is present, null will be returned.

If locale is null, the current default Locale returned by Locale.getLocale will be used.
Returns: the element description.
Parameters:
- elementName - the name of the element.
- locale - the Locale for which localization will be attempted.
Throws:
- IllegalArgumentException - if elementName is null, or is not a legal element name for this format.
See Also: IIOMetadataFormatImpl.setResourceBaseName(java.lang.String),

public int getElementMaxChildren (String elementName) [Specified in IIOMetadataFormat]

public int getElementMinChildren (String elementName) [Specified in IIOMetadataFormat]

public int getObjectArrayMaxLength (String elementName) [Specified in IIOMetadataFormat]

public int getObjectArrayMinLength (String elementName) [Specified in IIOMetadataFormat]

public Class<Object> getObjectClass (String elementName) [Specified in IIOMetadataFormat]

public Object getObjectDefaultValue (String elementName) [Specified in IIOMetadataFormat]

public Object getObjectEnumerations (String elementName) [Specified in IIOMetadataFormat]

public Comparable<Object> getObjectMaxValue (String elementName) [Specified in IIOMetadataFormat]

public Comparable<Object> getObjectMinValue (String elementName) [Specified in IIOMetadataFormat]

public int getObjectValueType (String elementName) [Specified in IIOMetadataFormat]

protected String getResourceBaseName ()

Returns the currently set base name for locating ResourceBundles.

Returns the currently set base name for locating
ResourceBundles.
Returns: a String containing the base name.
See Also: IIOMetadataFormatImpl.setResourceBaseName(java.lang.String),

public String getRootName () [Specified in IIOMetadataFormat]

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

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.
Returns: a predefined IIOMetadataFormat instance.

public boolean isAttributeRequired (String elementName, String attrName) [Specified in IIOMetadataFormat]

protected void removeAttribute (String elementName, String attrName)

Removes an attribute from a previously defined element.

Removes an attribute from a previously defined element. If no
attribute with the given name was present in the given element,
nothing happens and no exception is thrown.
Parameters:
- elementName - the name of the element.
- attrName - the name of the attribute being removed.
Throws:
- IllegalArgumentException - if elementName is null, or is not a legal element name for this format.

protected void removeElement (String elementName)

Removes an element from the format.

protected void removeObjectValue (String elementName)

Disallows an Object reference from being stored in nodes implementing the named element.

Disallows an Object reference from being stored in
nodes implementing the named element.
Parameters:
- elementName - the name of the element.
Throws:
- IllegalArgumentException - if elementName is not a legal element name for this format.

protected void setResourceBaseName (String resourceBaseName)

Sets a new base name for locating ResourceBundles containing descriptions of elements and attributes for this format.

Prior to the first time this method is called, the base name will be equal to this.getClass().getName() + "Resources".
Parameters:
- resourceBaseName - a String containg the new base name.
Throws:
- IllegalArgumentException - if resourceBaseName is null.
See Also: IIOMetadataFormatImpl.getResourceBaseName(),

Fields

Hide/Show inherited fields

publicfinalstatic int CHILD_POLICY_ALL = "1" [Inherited From IIOMetadataFormat]

A constant returned by getChildPolicy to indicate that an element must have a single instance of each of its legal child elements, in order.

A constant returned by getChildPolicy to indicate
that an element must have a single instance of each of its
legal child elements, in order. In DTD terms, the contents of
the element are defined by a sequence a,b,c,d,....

publicfinalstatic int CHILD_POLICY_CHOICE = "3" [Inherited From IIOMetadataFormat]

A constant returned by getChildPolicy to indicate that an element must have zero or one children, selected from among its legal child elements.

A constant returned by getChildPolicy to indicate
that an element must have zero or one children, selected from
among its legal child elements. In DTD terms, the contents of
the element are defined by a selection
a|b|c|d|....

publicfinalstatic int CHILD_POLICY_EMPTY = "0" [Inherited From IIOMetadataFormat]

A constant returned by getChildPolicy to indicate that an element may not have any children.

A constant returned by getChildPolicy to indicate
that an element may not have any children. In other words, it
is required to be a leaf node.

publicfinalstatic int CHILD_POLICY_MAX = "5" [Inherited From IIOMetadataFormat]

The largest valid CHILD_POLICY_* constant, to be used for range checks.

publicfinalstatic int CHILD_POLICY_REPEAT = "5" [Inherited From IIOMetadataFormat]

A constant returned by getChildPolicy to indicate that an element must have zero or more instances of its unique legal child element.

A constant returned by getChildPolicy to indicate
that an element must have zero or more instances of its unique
legal child element. In DTD terms, the contents of the element
are defined by a starred expression a*.

publicfinalstatic int CHILD_POLICY_SEQUENCE = "4" [Inherited From IIOMetadataFormat]

A constant returned by getChildPolicy to indicate that an element must have a sequence of instances of any of its legal child elements.

A constant returned by getChildPolicy to indicate
that an element must have a sequence of instances of any of its
legal child elements. In DTD terms, the contents of the
element are defined by a sequence (a|b|c|d|...)*.

publicfinalstatic int CHILD_POLICY_SOME = "2" [Inherited From IIOMetadataFormat]

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.

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. In DTD terms, the contents of
the element are defined by a sequence
a?,b?,c?,d?,....

publicfinalstatic int DATATYPE_BOOLEAN = "1" [Inherited From IIOMetadataFormat]

A constant returned by getAttributeDataType indicating that the value of an attribute is one of 'true' or 'false'.

publicfinalstatic int DATATYPE_DOUBLE = "4" [Inherited From IIOMetadataFormat]

A constant returned by getAttributeDataType indicating that the value of an attribute is a string representation of a double-precision decimal floating-point number.

publicfinalstatic int DATATYPE_FLOAT = "3" [Inherited From IIOMetadataFormat]

A constant returned by getAttributeDataType indicating that the value of an attribute is a string representation of a decimal floating-point number.

publicfinalstatic int DATATYPE_INTEGER = "2" [Inherited From IIOMetadataFormat]

A constant returned by getAttributeDataType indicating that the value of an attribute is a string representation of an integer.

publicfinalstatic int DATATYPE_STRING = "0" [Inherited From IIOMetadataFormat]

A constant returned by getAttributeDataType indicating that the value of an attribute is a general Unicode string.

publicfinalstatic String standardMetadataFormatName = "javax_imageio_1.0"

A String constant containing the standard format name, "javax_imageio_1.0".

publicfinalstatic int VALUE_ARBITRARY = "1" [Inherited From IIOMetadataFormat]

A constant returned by getAttributeValueType and getObjectValueType to indicate that the attribute or user object may be set a single, arbitrary value.

publicfinalstatic int VALUE_ENUMERATION = "16" [Inherited From IIOMetadataFormat]

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.

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. In the case of attributes, these values are Strings; for objects, they are Objects implementing a given class or interface.

Attribute values of type DATATYPE_BOOLEAN should be marked as enumerations.

publicfinalstatic int VALUE_LIST = "32" [Inherited From IIOMetadataFormat]

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.

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. In the
case of attributes, the list will consist of
whitespace-separated values within a String; for
objects, an array will be used.

publicfinalstatic int VALUE_NONE = "0" [Inherited From IIOMetadataFormat]

A constant returned by getObjectValueType to indicate the absence of a user object.

publicfinalstatic int VALUE_RANGE = "2" [Inherited From IIOMetadataFormat]

A constant returned by getAttributeValueType and getObjectValueType to indicate that the attribute or user object may be set a range of values.

A constant returned by getAttributeValueType and
getObjectValueType to indicate that the attribute
or user object may be set a range of values. Both the minimum
and maximum values of the range are exclusive. It is
recommended that ranges of integers be inclusive on both ends,
and that exclusive ranges be used only for floating-point data.
See Also: IIOMetadataFormat.VALUE_RANGE_MIN_MAX_INCLUSIVE,

publicfinalstatic int VALUE_RANGE_MAX_INCLUSIVE = "10" [Inherited From IIOMetadataFormat]

A constant returned by getAttributeValueType and getObjectValueType to indicate that the attribute or user object may be set to a range of values.

A constant returned by getAttributeValueType and
getObjectValueType to indicate that the attribute
or user object may be set to a range of values. The maximum
(but not the minimum) value of the range is inclusive.

publicfinalstatic int VALUE_RANGE_MAX_INCLUSIVE_MASK = "8" [Inherited From IIOMetadataFormat]

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.

Similarly, the value may be and'ed with the value of getAttributeValueTypeor getObjectValueType to determine if the maximum value of the range is inclusive.

publicfinalstatic int VALUE_RANGE_MIN_INCLUSIVE = "6" [Inherited From IIOMetadataFormat]

A constant returned by getAttributeValueType and getObjectValueType to indicate that the attribute or user object may be set to a range of values.

A constant returned by getAttributeValueType and
getObjectValueType to indicate that the attribute
or user object may be set to a range of values. The minimum
(but not the maximum) value of the range is inclusive.

publicfinalstatic int VALUE_RANGE_MIN_INCLUSIVE_MASK = "4" [Inherited From IIOMetadataFormat]

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.

Similarly, the value may be and'ed with the value of getAttributeValueTypeor getObjectValueType to determine if the minimum value of the range is inclusive.

publicfinalstatic int VALUE_RANGE_MIN_MAX_INCLUSIVE = "14" [Inherited From IIOMetadataFormat]

A constant returned by getAttributeValueType and getObjectValueType to indicate that the attribute or user object may be set a range of values.

A constant returned by getAttributeValueType and
getObjectValueType to indicate that the attribute
or user object may be set a range of values. Both the minimum
and maximum values of the range are inclusive. It is
recommended that ranges of integers be inclusive on both ends,
and that exclusive ranges be used only for floating-point data.