com.github.jaiimageio.plugins.tiff.TIFFTagSet Maven / Gradle / Ivy
/*
* $RCSfile: TIFFTagSet.java,v $
*
*
* Copyright (c) 2005 Sun Microsystems, Inc. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* - Redistribution of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistribution in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of Sun Microsystems, Inc. or the names of
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* This software is provided "AS IS," without a warranty of any
* kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND
* WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
* EXCLUDED. SUN MIDROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL
* NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF
* USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
* DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR
* ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
* CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
* REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
* INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGES.
*
* You acknowledge that this software is not designed or intended for
* use in the design, construction, operation or maintenance of any
* nuclear facility.
*
* $Revision: 1.1 $
* $Date: 2005/02/11 05:01:19 $
* $State: Exp $
*/
package com.github.jaiimageio.plugins.tiff;
// Should implement Set?
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import java.util.SortedMap;
import java.util.SortedSet;
import java.util.TreeMap;
import java.util.TreeSet;
/**
* 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 ts
* data values.
*
* @see TIFFTag
*/
public class TIFFTagSet {
private SortedMap allowedTagsByNumber = new TreeMap();
private SortedMap allowedTagsByName = new TreeMap();
/**
* Constructs a TIFFTagSet.
*/
private TIFFTagSet() {}
/**
* Constructs a TIFFTagSet, given a List
* of TIFFTag objects.
*
* @param 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.
*/
public TIFFTagSet(List tags) {
if (tags == null) {
throw new IllegalArgumentException("tags == null!");
}
Iterator iter = tags.iterator();
while (iter.hasNext()) {
Object o = iter.next();
if (!(o instanceof TIFFTag)) {
throw new IllegalArgumentException(
"tags contains a non-TIFFTag!");
}
TIFFTag tag = (TIFFTag)o;
allowedTagsByNumber.put(new Integer(tag.getNumber()), tag);
allowedTagsByName.put(tag.getName(), tag);
}
}
/**
* Returns the TIFFTag from this set that is
* associated with the given tag number, or null if
* no tag exists for that number.
*
* @param tagNumber the number of the tag to be retrieved.
*
* @return the numbered TIFFTag, or null.
*/
public TIFFTag getTag(int tagNumber) {
return (TIFFTag)allowedTagsByNumber.get(new Integer(tagNumber));
}
/**
* Returns the TIFFTag having the given tag name, or
* null if the named tag does not belong to this tag set.
*
* @param tagName the name of the tag to be retrieved, as a
* String.
*
* @return the named TIFFTag, or null.
*
* @throws IllegalArgumentException if tagName is
* null.
*/
public TIFFTag getTag(String tagName) {
if (tagName == null) {
throw new IllegalArgumentException("tagName == null!");
}
return (TIFFTag)allowedTagsByName.get(tagName);
}
/**
* 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
* {@link Integer#compareTo(Object)}.
*
* @return All tag numbers in this set.
*/
public SortedSet getTagNumbers() {
Set tagNumbers = allowedTagsByNumber.keySet();
SortedSet sortedTagNumbers;
if(tagNumbers instanceof SortedSet) {
sortedTagNumbers = (SortedSet)tagNumbers;
} else {
sortedTagNumbers = new TreeSet(tagNumbers);
}
return Collections.unmodifiableSortedSet(sortedTagNumbers);
}
/**
* 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
* {@link String#compareTo(Object)}.
*
* @return All tag names in this set.
*/
public SortedSet getTagNames() {
Set tagNames = allowedTagsByName.keySet();
SortedSet sortedTagNames;
if(tagNames instanceof SortedSet) {
sortedTagNames = (SortedSet)tagNames;
} else {
sortedTagNames = new TreeSet(tagNames);
}
return Collections.unmodifiableSortedSet(sortedTagNames);
}
}