Class TIFFTagSet

java.lang.Object

javax.imageio.plugins.tiff.TIFFTagSet

Direct Known Subclasses:

BaselineTIFFTagSet, ExifGPSTagSet, ExifInteroperabilityTagSet, ExifParentTIFFTagSet, ExifTIFFTagSet, FaxTIFFTagSet, GeoTIFFTagSet

public class TIFFTagSet
extends Object

A class representing a set of TIFF tags. Each tag in the set must have a unique number (this is a limitation of the TIFF specification itself).

This class and its subclasses are responsible for mapping between raw tag numbers and TIFFTag objects, which contain additional information about each tag, such as the tag's name, legal data types, and mnemonic names for some or all of its data values.

Since:

9

See Also:

• TIFFTag

Constructor Summary

Constructors

Constructor	Description
TIFFTagSet(List<TIFFTag> tags)	Constructs a TIFFTagSet, given a List of TIFFTag objects.

Method Summary

Modifier and Type	Method	Description
TIFFTag	getTag(int tagNumber)	Returns the TIFFTag from this set that is associated with the given tag number, or null if no tag exists for that number.
TIFFTag	getTag(String tagName)	Returns the TIFFTag having the given tag name, or null if the named tag does not belong to this tag set.
SortedSet<String>	getTagNames()	Retrieves an unmodifiable lexicographically increasing set of tag names.
SortedSet<Integer>	getTagNumbers()	Retrieves an unmodifiable numerically increasing set of tag numbers.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Constructor Details

TIFFTagSet

public TIFFTagSet(List<TIFFTag> tags)

Constructs a TIFFTagSet, given a List of TIFFTag objects.

Parameters:

tags - a List object containing TIFFTag objects to be added to this tag set.

Throws:

IllegalArgumentException - if tags is null, or contains objects that are not instances of the TIFFTag class.

Method Details

getTag

public TIFFTag getTag(int tagNumber)

Returns the TIFFTag from this set that is associated with the given tag number, or null if no tag exists for that number.

Parameters:

tagNumber - the number of the tag to be retrieved.

Returns:

the numbered TIFFTag, or null.

getTag

public TIFFTag getTag(String tagName)

Returns the TIFFTag having the given tag name, or null if the named tag does not belong to this tag set.

Parameters:

tagName - the name of the tag to be retrieved, as a String.

Returns:

the named TIFFTag, or null.

Throws:

IllegalArgumentException - if tagName is null.

getTagNumbers

public SortedSet<Integer> getTagNumbers()

Retrieves an unmodifiable numerically increasing set of tag numbers.

The returned object is unmodifiable and contains the tag numbers of all TIFFTags in this TIFFTagSet sorted into ascending order according to Comparable.compareTo(Object).

Returns:

All tag numbers in this set.

getTagNames

public SortedSet<String> getTagNames()

Retrieves an unmodifiable lexicographically increasing set of tag names.

The returned object is unmodifiable and contains the tag names of all TIFFTags in this TIFFTagSet sorted into ascending order according to Comparable.compareTo(Object).

Returns:

All tag names in this set.