APIdia Launch Partner
Top Fields Constructors Methods
com.sun.imageio.plugins.tiff

public abstract Class TIFFMetadataFormat

extends Object
implements IIOMetadataFormat
Class Inheritance
All Implemented Interfaces
javax.imageio.metadata.IIOMetadataFormat
Known Direct Subclasses
com.sun.imageio.plugins.tiff.TIFFImageMetadataFormat, com.sun.imageio.plugins.tiff.TIFFStreamMetadataFormat
Imports
java.util.HashMap, .Locale, .Map, .MissingResourceException, .ResourceBundle, javax.imageio.metadata.IIOMetadataFormat

Field Summary

Modifier and TypeField and Description
protected Map<String, TIFFAttrInfo>
attrInfoMap

protected Map<String, TIFFElementInfo>
elementInfoMap

protected String
resourceBaseName

protected String
rootName

Constructor Summary

AccessConstructor and Description
public
TIFFMetadataFormat()

Method Summary

Modifier and TypeMethod and Description
public int
getAttributeDataType(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeDataType.

Returns one of the constants starting with DATATYPE_, indicating the format and interpretation of the value of the given attribute within the named element.

public String
getAttributeDefaultValue(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeDefaultValue.

Returns the default value of the named attribute, if it is not explicitly present within the named element, as a String, or null if no default value is available.

public String
getAttributeDescription(String elementName, String attrName, Locale locale)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeDescription.

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

public String[]
getAttributeEnumerations(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeEnumerations.

Returns an array of Strings containing the legal enumerated values for the given attribute within the named element.

public int
getAttributeListMaxLength(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeListMaxLength.

Returns the maximum number of list items that may be used to define this attribute.

public int
getAttributeListMinLength(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeListMinLength.

Returns the minimum number of list items that may be used to define this attribute.

public String
getAttributeMaxValue(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeMaxValue.

Returns the maximum legal value for the attribute.

public String
getAttributeMinValue(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeMinValue.

Returns the minimum legal value for the attribute.

public String[]
getAttributeNames(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeNames.

Returns an array of Strings listing the names of the attributes that may be associated with the named element.

public int
getAttributeValueType(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeValueType.

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.

private TIFFAttrInfo
getAttrInfo(String elementName, String attrName)

public String[]
getChildNames(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getChildNames.

Returns an array of Strings indicating the names of the element which are allowed to be children of the named element, in the order in which they should appear.

public int
getChildPolicy(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getChildPolicy.

Returns one of the constants starting with CHILD_POLICY_, indicating the legal pattern of children for the named element.

public String
getElementDescription(String elementName, Locale locale)

Implements javax.imageio.metadata.IIOMetadataFormat.getElementDescription.

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

private TIFFElementInfo
getElementInfo(String elementName)

public int
getElementMaxChildren(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getElementMaxChildren.

Returns the maximum number of children of the named element with child policy CHILD_POLICY_REPEAT.

public int
getElementMinChildren(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getElementMinChildren.

Returns the minimum number of children of the named element with child policy CHILD_POLICY_REPEAT.

public int
getObjectArrayMaxLength(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getObjectArrayMaxLength.

Returns the maximum number of array elements that may be used to define the Object reference within the named element.

public int
getObjectArrayMinLength(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getObjectArrayMinLength.

Returns the minimum number of array elements that may be used to define the Object reference within the named element.

public Class<?>
getObjectClass(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getObjectClass.

Returns the Class type of the Object reference stored within the element.

public Object
getObjectDefaultValue(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getObjectDefaultValue.

Returns an Objects containing the default value for the Object reference within the named element.

public Object[]
getObjectEnumerations(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getObjectEnumerations.

Returns an array of Objects containing the legal enumerated values for the Object reference within the named element.

public Comparable<Object>
getObjectMaxValue(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getObjectMaxValue.

Returns the maximum legal value for the Object reference within the named element.

public Comparable<Object>
getObjectMinValue(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getObjectMinValue.

Returns the minimum legal value for the Object reference within the named element.

public int
getObjectValueType(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getObjectValueType.

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.

private String
getResource(String key, Locale locale)

public String
getRootName()

Implements javax.imageio.metadata.IIOMetadataFormat.getRootName.

Returns the name of the root element of the format.

public boolean
isAttributeRequired(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.isAttributeRequired.

Returns true if the named attribute must be present within the named element.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

attrInfoMapback to summary
protected Map<String, TIFFAttrInfo> attrInfoMap
elementInfoMapback to summary
protected Map<String, TIFFElementInfo> elementInfoMap
resourceBaseNameback to summary
protected String resourceBaseName
rootNameback to summary
protected String rootName

Constructor Detail

TIFFMetadataFormatback to summary
public TIFFMetadataFormat()

Method Detail

getAttributeDataTypeback to summary
public int getAttributeDataType(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeDataType.

Doc from javax.imageio.metadata.IIOMetadataFormat.getAttributeDataType.

Returns one of the constants starting with DATATYPE_, indicating the format and interpretation of the value of the given attribute within the named element. If getAttributeValueType returns VALUE_LIST, then the legal value is a whitespace-spearated list of values of the returned datatype.

Annotations
@Override
getAttributeDefaultValueback to summary
public String getAttributeDefaultValue(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeDefaultValue.

Doc from javax.imageio.metadata.IIOMetadataFormat.getAttributeDefaultValue.

Returns the default value of the named attribute, if it is not explicitly present within the named element, as a String, or null if no default value is available.

Annotations
@Override
getAttributeDescriptionback to summary
public String getAttributeDescription(String elementName, String attrName, Locale locale)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeDescription.

Doc from javax.imageio.metadata.IIOMetadataFormat.getAttributeDescription.

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

If locale is null, the current default Locale returned by Locale.getLocale will be used.

Annotations
@Override
getAttributeEnumerationsback to summary
public String[] getAttributeEnumerations(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeEnumerations.

Doc from javax.imageio.metadata.IIOMetadataFormat.getAttributeEnumerations.

Returns an array of Strings containing the legal enumerated values for the given attribute within the named element. This method should only be called if getAttributeValueType returns VALUE_ENUMERATION.

Annotations
@Override
getAttributeListMaxLengthback to summary
public int getAttributeListMaxLength(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeListMaxLength.

Doc from javax.imageio.metadata.IIOMetadataFormat.getAttributeListMaxLength.

Returns the maximum number of list items that may be used to define this attribute. A value of Integer.MAX_VALUE may be used to specify that there is no upper bound. The attribute itself is defined as a String containing multiple whitespace-separated items. This method should only be called if getAttributeValueType returns VALUE_LIST.

Annotations
@Override
getAttributeListMinLengthback to summary
public int getAttributeListMinLength(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeListMinLength.

Doc from javax.imageio.metadata.IIOMetadataFormat.getAttributeListMinLength.

Returns the minimum number of list items that may be used to define this attribute. The attribute itself is defined as a String containing multiple whitespace-separated items. This method should only be called if getAttributeValueType returns VALUE_LIST.

Annotations
@Override
getAttributeMaxValueback to summary
public String getAttributeMaxValue(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeMaxValue.

Doc from javax.imageio.metadata.IIOMetadataFormat.getAttributeMaxValue.

Returns the maximum legal value for the attribute. Whether this value is inclusive or exclusive may be determined by the value of getAttributeValueType. The value is returned as a String; its interpretation is dependent on the value of getAttributeDataType. This method should only be called if getAttributeValueType returns VALUE_RANGE_*.

Annotations
@Override
getAttributeMinValueback to summary
public String getAttributeMinValue(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeMinValue.

Doc from javax.imageio.metadata.IIOMetadataFormat.getAttributeMinValue.

Returns the minimum legal value for the attribute. Whether this value is inclusive or exclusive may be determined by the value of getAttributeValueType. The value is returned as a String; its interpretation is dependent on the value of getAttributeDataType. This method should only be called if getAttributeValueType returns VALUE_RANGE_*.

Annotations
@Override
getAttributeNamesback to summary
public String[] getAttributeNames(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeNames.

Doc from javax.imageio.metadata.IIOMetadataFormat.getAttributeNames.

Returns an array of Strings listing the names of the attributes that may be associated with the named element.

Annotations
@Override
getAttributeValueTypeback to summary
public int getAttributeValueType(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.getAttributeValueType.

Doc from javax.imageio.metadata.IIOMetadataFormat.getAttributeValueType.

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.

Annotations
@Override
getAttrInfoback to summary
private TIFFAttrInfo getAttrInfo(String elementName, String attrName)
getChildNamesback to summary
public String[] getChildNames(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getChildNames.

Doc from javax.imageio.metadata.IIOMetadataFormat.getChildNames.

Returns an array of Strings indicating the names of the element which are allowed to be children of the named element, in the order in which they should appear. If the element cannot have children, null is returned.

Annotations
@Override
getChildPolicyback to summary
public int getChildPolicy(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getChildPolicy.

Doc from javax.imageio.metadata.IIOMetadataFormat.getChildPolicy.

Returns one of the constants starting with CHILD_POLICY_, indicating the legal pattern of children for the named element.

Annotations
@Override
getElementDescriptionback to summary
public String getElementDescription(String elementName, Locale locale)

Implements javax.imageio.metadata.IIOMetadataFormat.getElementDescription.

Doc from javax.imageio.metadata.IIOMetadataFormat.getElementDescription.

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

If locale is null, the current default Locale returned by Locale.getLocale will be used.

Annotations
@Override
getElementInfoback to summary
private TIFFElementInfo getElementInfo(String elementName)
getElementMaxChildrenback to summary
public int getElementMaxChildren(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getElementMaxChildren.

Doc from javax.imageio.metadata.IIOMetadataFormat.getElementMaxChildren.

Returns the maximum number of children of the named element with child policy CHILD_POLICY_REPEAT. For example, an element representing an entry in an 8-bit color palette might be allowed to repeat up to 256 times. A value of Integer.MAX_VALUE may be used to specify that there is no upper bound.

Annotations
@Override
getElementMinChildrenback to summary
public int getElementMinChildren(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getElementMinChildren.

Doc from javax.imageio.metadata.IIOMetadataFormat.getElementMinChildren.

Returns the minimum number of children of the named element with child policy CHILD_POLICY_REPEAT. For example, an element representing color primary information might be required to have at least 3 children, one for each primary.

Annotations
@Override
getObjectArrayMaxLengthback to summary
public int getObjectArrayMaxLength(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getObjectArrayMaxLength.

Doc from javax.imageio.metadata.IIOMetadataFormat.getObjectArrayMaxLength.

Returns the maximum number of array elements that may be used to define the Object reference within the named element. A value of Integer.MAX_VALUE may be used to specify that there is no upper bound. This method should only be called if getObjectValueType returns VALUE_LIST.

Annotations
@Override
getObjectArrayMinLengthback to summary
public int getObjectArrayMinLength(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getObjectArrayMinLength.

Doc from javax.imageio.metadata.IIOMetadataFormat.getObjectArrayMinLength.

Returns the minimum number of array elements that may be used to define the Object reference within the named element. This method should only be called if getObjectValueType returns VALUE_LIST.

Annotations
@Override
getObjectClassback to summary
public Class<?> getObjectClass(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getObjectClass.

Doc from javax.imageio.metadata.IIOMetadataFormat.getObjectClass.

Returns the Class type of the Object reference stored within the element. If this element may not contain an Object reference, an IllegalArgumentException will be thrown. If the class type is an array, this field indicates the underlying class type (e.g, for an array of ints, this method would return int.class).

Object references whose legal values are defined as a range must implement the Comparable interface.

Annotations
@Override
getObjectDefaultValueback to summary
public Object getObjectDefaultValue(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getObjectDefaultValue.

Doc from javax.imageio.metadata.IIOMetadataFormat.getObjectDefaultValue.

Returns an Objects containing the default value for the Object reference within the named element.

Annotations
@Override
getObjectEnumerationsback to summary
public Object[] getObjectEnumerations(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getObjectEnumerations.

Doc from javax.imageio.metadata.IIOMetadataFormat.getObjectEnumerations.

Returns an array of Objects containing the legal enumerated values for the Object reference within the named element. This method should only be called if getObjectValueType returns VALUE_ENUMERATION.

The Object associated with a node that accepts enumerated values must be equal to one of the values returned by this method, as defined by the == operator (as opposed to the Object.equals method).

Annotations
@Override
getObjectMaxValueback to summary
public Comparable<Object> getObjectMaxValue(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getObjectMaxValue.

Doc from javax.imageio.metadata.IIOMetadataFormat.getObjectMaxValue.

Returns the maximum legal value for the Object reference within the named element. Whether this value is inclusive or exclusive may be determined by the value of getObjectValueType. This method should only be called if getObjectValueType returns one of the constants starting with VALUE_RANGE.

Annotations
@Override
getObjectMinValueback to summary
public Comparable<Object> getObjectMinValue(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getObjectMinValue.

Doc from javax.imageio.metadata.IIOMetadataFormat.getObjectMinValue.

Returns the minimum legal value for the Object reference within the named element. Whether this value is inclusive or exclusive may be determined by the value of getObjectValueType. This method should only be called if getObjectValueType returns one of the constants starting with VALUE_RANGE.

Annotations
@Override
getObjectValueTypeback to summary
public int getObjectValueType(String elementName)

Implements javax.imageio.metadata.IIOMetadataFormat.getObjectValueType.

Doc from javax.imageio.metadata.IIOMetadataFormat.getObjectValueType.

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. If no object value can be stored within the given element, the result of this method will be VALUE_NONE.

Object references whose legal values are defined as a range must implement the Comparable interface.

Annotations
@Override
getResourceback to summary
private String getResource(String key, Locale locale)
getRootNameback to summary
public String getRootName()

Implements javax.imageio.metadata.IIOMetadataFormat.getRootName.

Doc from javax.imageio.metadata.IIOMetadataFormat.getRootName.

Returns the name of the root element of the format.

Annotations
@Override
isAttributeRequiredback to summary
public boolean isAttributeRequired(String elementName, String attrName)

Implements javax.imageio.metadata.IIOMetadataFormat.isAttributeRequired.

Doc from javax.imageio.metadata.IIOMetadataFormat.isAttributeRequired.

Returns true if the named attribute must be present within the named element.

Annotations
@Override