javax.imageio.metadata.IIOMetadataFormatImpl — clojure-interop/javax.imageio 1.0.5

A concrete class providing a reusable implementation of the IIOMetadataFormat interface. In addition, a static instance representing the standard, plug-in neutral javax_imageio_1.0 format is provided by the getStandardFormatInstance method.

In order to supply localized descriptions of elements and attributes, a ResourceBundle with a base name of this.getClass().getName() "Resources" should be supplied via the usual mechanism used by ResourceBundle.getBundle. Briefly, the subclasser supplies one or more additional classes according to a naming convention (by default, the fully-qualified name of the subclass extending IIMetadataFormatImpl, plus the string "Resources", plus the country, language, and variant codes separated by underscores). At run time, calls to getElementDescription or getAttributeDescription will attempt to load such classes dynamically according to the supplied locale, and will use either the element name, or the element name followed by a '/' character followed by the attribute name as a key. This key will be supplied to the ResourceBundle's getString method, and the resulting localized description of the node or attribute is returned.

The subclass may supply a different base name for the resource bundles using the setResourceBaseName method.

A subclass may choose its own localization mechanism, if so desired, by overriding the supplied implementations of getElementDescription and getAttributeDescription.

*-standard-metadata-format-name clj

Static Constant.

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

type: java.lang.String

*get-standard-format-instance clj

(*get-standard-format-instance)

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. - javax.imageio.metadata.IIOMetadataFormat

->iio-metadata-format-impl clj

(->iio-metadata-format-impl root-name child-policy)

(->iio-metadata-format-impl root-name min-children max-children)

Constructor.

Constructs a blank IIOMetadataFormatImpl instance, with a given root element name and a child policy of CHILD_POLICY_REPEAT. Additional elements, and their attributes and Object reference information may be added using the various add methods.

root-name - the name of the root element. - java.lang.String min-children - the minimum number of children of the node. - int max-children - the maximum number of children of the node. - int

throws: java.lang.IllegalArgumentException - if minChildren is negative or larger than maxChildren.

attribute-required? clj

(attribute-required? this element-name attr-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String attr-name - the name of the attribute being queried. - java.lang.String

returns: true if the attribute must be present. - boolean

can-node-appear? clj

(can-node-appear? this element-name image-type)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String image-type - an ImageTypeSpecifier indicating the type of the image that will be associated with the metadata. - javax.imageio.ImageTypeSpecifier

returns: true if the node is meaningful for images of the given type. - boolean

get-attribute-data-type clj

(get-attribute-data-type this element-name attr-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String attr-name - the name of the attribute being queried. - java.lang.String

returns: one of the DATATYPE_* constants. - int

get-attribute-default-value clj

(get-attribute-default-value this element-name attr-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String attr-name - the name of the attribute being queried. - java.lang.String

returns: a String containing the default value, or null. - java.lang.String

get-attribute-description clj

(get-attribute-description this element-name attr-name locale)

Returns a String containing a description of the named attribute, or null. The description 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.

element-name - the name of the element. - java.lang.String attr-name - the name of the attribute. - java.lang.String locale - the Locale for which localization will be attempted, or null. - java.util.Locale

returns: the attribute description. - java.lang.String

throws: java.lang.IllegalArgumentException - if attrName is null or is not a legal attribute name for this element.

get-attribute-enumerations clj

(get-attribute-enumerations this element-name attr-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String attr-name - the name of the attribute being queried. - java.lang.String

returns: an array of Strings. - java.lang.String[]

get-attribute-list-max-length clj

(get-attribute-list-max-length this element-name attr-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String attr-name - the name of the attribute being queried. - java.lang.String

returns: the largest legal number of list items for the attribute. - int

get-attribute-list-min-length clj

(get-attribute-list-min-length this element-name attr-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String attr-name - the name of the attribute being queried. - java.lang.String

returns: the smallest legal number of list items for the attribute. - int

get-attribute-max-value clj

(get-attribute-max-value this element-name attr-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried, as a String. - java.lang.String attr-name - the name of the attribute being queried. - java.lang.String

returns: a String containing the largest legal value for the attribute. - java.lang.String

get-attribute-min-value clj

(get-attribute-min-value this element-name attr-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String attr-name - the name of the attribute being queried. - java.lang.String

returns: a String containing the smallest legal value for the attribute. - java.lang.String

get-attribute-names clj

(get-attribute-names this element-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String

returns: an array of Strings. - java.lang.String[]

get-attribute-value-type clj

(get-attribute-value-type this element-name attr-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String attr-name - the name of the attribute being queried. - java.lang.String

returns: one of the VALUE_* constants. - int

get-child-names clj

(get-child-names this element-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String

returns: an array of Strings, or null. - java.lang.String[]

get-child-policy clj

(get-child-policy this element-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String

returns: one of the CHILD_POLICY_* constants. - int

get-element-description clj

(get-element-description this element-name locale)

Returns a String containing a description of the named element, or null. The description 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.

element-name - the name of the element. - java.lang.String locale - the Locale for which localization will be attempted. - java.util.Locale

returns: the element description. - java.lang.String

throws: java.lang.IllegalArgumentException - if elementName is null, or is not a legal element name for this format.

get-element-max-children clj

(get-element-max-children this element-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String

returns: an int. - int

get-element-min-children clj

(get-element-min-children this element-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String

returns: an int. - int

get-object-array-max-length clj

(get-object-array-max-length this element-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String

returns: the largest valid array length for the Object reference. - int

get-object-array-min-length clj

(get-object-array-min-length this element-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String

returns: the smallest valid array length for the Object reference. - int

get-object-class clj

(get-object-class this element-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String

returns: a Class object. - java.lang.Class<?>

get-object-default-value clj

(get-object-default-value this element-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String

returns: an Object. - java.lang.Object

get-object-enumerations clj

(get-object-enumerations this element-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String

returns: an array of Objects. - java.lang.Object[]

get-object-max-value clj

(get-object-max-value this element-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String

returns: the smallest legal value for the attribute. - java.lang.Comparable<?>

get-object-min-value clj

(get-object-min-value this element-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String

returns: the smallest legal value for the attribute. - java.lang.Comparable<?>

get-object-value-type clj

(get-object-value-type this element-name)

Description copied from interface: IIOMetadataFormat

element-name - the name of the element being queried. - java.lang.String

returns: one of the VALUE_* constants. - int

get-root-name clj

(get-root-name this)

Description copied from interface: IIOMetadataFormat

returns: a String. - java.lang.String