jdk/src/java.desktop/share/classes/javax/imageio/plugins/tiff/TIFFImageReadParam.java
author bpb
Thu, 11 Feb 2016 13:42:53 -0800
changeset 36448 a07e108d5722
parent 35302 e4d2275861c3
child 41900 6181b834ba16
permissions -rw-r--r--
8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes Summary: Change <code>foo</code> to {@code foo} in TIFF plugin classes and 2015 to 2016 where needed. Reviewed-by: prr, darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
34416
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
     1
/*
36448
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
     2
 * Copyright (c) 2005, 2016, Oracle and/or its affiliates. All rights reserved.
34416
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
     4
 *
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    10
 *
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    15
 * accompanied this code).
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    16
 *
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    20
 *
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    23
 * questions.
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    24
 */
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    25
package javax.imageio.plugins.tiff;
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    26
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    27
import java.util.ArrayList;
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    28
import java.util.List;
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    29
import javax.imageio.ImageReadParam;
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    30
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    31
/**
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    32
 * A subclass of {@link ImageReadParam} allowing control over
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    33
 * the TIFF reading process.
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    34
 *
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    35
 * <p> Because TIFF is an extensible format, the reader requires
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    36
 * information about any tags used by TIFF extensions in order to emit
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    37
 * meaningful metadata.  Also, TIFF extensions may define new
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    38
 * compression types.  Both types of information about extensions may
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    39
 * be provided by this interface.
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    40
 *
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    41
 * <p> Additional TIFF tags must be organized into
36448
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    42
 * {@code TIFFTagSet}s.  A {@code TIFFTagSet} may be
34416
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    43
 * provided to the reader by means of the
36448
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    44
 * {@code addAllowedTagSet} method.  By default, the tag sets
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    45
 * {@code BaselineTIFFTagSet}, {@code FaxTIFFTagSet},
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    46
 * {@code ExifParentTIFFTagSet}, and {@code GeoTIFFTagSet}
34416
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    47
 * are included.
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    48
 *
35302
e4d2275861c3 8136494: Update "@since 1.9" to "@since 9" to match java.version.specification
iris
parents: 34416
diff changeset
    49
 * @since 9
34416
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    50
 */
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    51
public class TIFFImageReadParam extends ImageReadParam {
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    52
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    53
    private List<TIFFTagSet> allowedTagSets = new ArrayList<TIFFTagSet>(4);
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    54
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    55
    /**
36448
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    56
     * Constructs a {@code TIFFImageReadParam}.  Tags defined by
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    57
     * the {@code TIFFTagSet}s {@code BaselineTIFFTagSet},
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    58
     * {@code FaxTIFFTagSet}, {@code ExifParentTIFFTagSet}, and
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    59
     * {@code GeoTIFFTagSet} will be supported.
34416
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    60
     *
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    61
     * @see BaselineTIFFTagSet
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    62
     * @see FaxTIFFTagSet
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    63
     * @see ExifParentTIFFTagSet
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    64
     * @see GeoTIFFTagSet
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    65
     */
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    66
    public TIFFImageReadParam() {
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    67
        addAllowedTagSet(BaselineTIFFTagSet.getInstance());
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    68
        addAllowedTagSet(FaxTIFFTagSet.getInstance());
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    69
        addAllowedTagSet(ExifParentTIFFTagSet.getInstance());
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    70
        addAllowedTagSet(GeoTIFFTagSet.getInstance());
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    71
    }
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    72
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    73
    /**
36448
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    74
     * Adds a {@code TIFFTagSet} object to the list of allowed
34416
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    75
     * tag sets.
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    76
     *
36448
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    77
     * @param tagSet a {@code TIFFTagSet}.
34416
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    78
     *
36448
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    79
     * @throws IllegalArgumentException if {@code tagSet} is
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    80
     * {@code null}.
34416
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    81
     */
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    82
    public void addAllowedTagSet(TIFFTagSet tagSet) {
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    83
        if (tagSet == null) {
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    84
            throw new IllegalArgumentException("tagSet == null!");
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    85
        }
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    86
        allowedTagSets.add(tagSet);
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    87
    }
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    88
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    89
    /**
36448
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    90
     * Removes a {@code TIFFTagSet} object from the list of
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    91
     * allowed tag sets.  Removal is based on the {@code equals}
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    92
     * method of the {@code TIFFTagSet}, which is normally
34416
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    93
     * defined as reference equality.
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    94
     *
36448
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    95
     * @param tagSet a {@code TIFFTagSet}.
34416
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    96
     *
36448
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    97
     * @throws IllegalArgumentException if {@code tagSet} is
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
    98
     * {@code null}.
34416
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
    99
     */
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
   100
    public void removeAllowedTagSet(TIFFTagSet tagSet) {
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
   101
        if (tagSet == null) {
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
   102
            throw new IllegalArgumentException("tagSet == null!");
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
   103
        }
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
   104
        allowedTagSets.remove(tagSet);
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
   105
    }
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
   106
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
   107
    /**
36448
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
   108
     * Returns a {@code List} containing the allowed
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
   109
     * {@code TIFFTagSet} objects.
34416
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
   110
     *
36448
a07e108d5722 8149593: Change <code>foo</code> to {@code foo} in TIFF plugin classes
bpb
parents: 35302
diff changeset
   111
     * @return a {@code List} of {@code TIFFTagSet}s.
34416
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
   112
     */
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
   113
    public List<TIFFTagSet> getAllowedTagSets() {
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
   114
        return allowedTagSets;
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
   115
    }
68c0d866db5d 8143342: Integrate Java Image I/O support for TIFF per JEP 262
bpb
parents:
diff changeset
   116
}