jdk/src/share/classes/javax/imageio/metadata/package.html
author ohair
Wed, 26 May 2010 20:28:04 -0700
changeset 5551 327690766109
parent 5506 202f599c92aa
permissions -rw-r--r--
6956202: Fix a few missed rebranding issues, please contact lines etc. Reviewed-by: jjg, darcy, weijun
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
<html>
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
<head>
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
<!--
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     5
Copyright (c) 2000, 2003, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    10
published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    12
by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
5551
327690766109 6956202: Fix a few missed rebranding issues, please contact lines etc.
ohair
parents: 5506
diff changeset
    24
Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
327690766109 6956202: Fix a few missed rebranding issues, please contact lines etc.
ohair
parents: 5506
diff changeset
    25
or visit www.oracle.com if you need additional information or have any
327690766109 6956202: Fix a few missed rebranding issues, please contact lines etc.
ohair
parents: 5506
diff changeset
    26
questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
-->
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
</head>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
<body bgcolor="white">
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
A package of the Java Image I/O API dealing with reading and writing
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
metadata.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
When reading an image, its per-stream and per-image metadata is made
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
available as an <code>IIOMetadata</code> object.  The internals of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
this object are specific to the plug-in that created it.  Its contents
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
may be accessed in the form of an XML <code>Document</code>, which is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
implemented as a tree of <code>IIOMetadataNode</code> objects.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
When writing an image, its metadata may be set by defining or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
modifying an <code>IIOMetadata</code> object.  Such an object may be
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
obtained from an <code>ImageWriter</code> or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
<code>ImageTranscoder</code> (from the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
<code>javax.imageio</code> package).  Once such an object has
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
been obtained, its contents may be set of modified via a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
<code>Document</code> consisting of <code>IIOMetadataNode</code>s.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
The document format may optionally be described using an
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
<code>IIOMetadataFormat</code> object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
The format of the metadata contained in the XML <code>Document</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
is identified by a string which appears as the root node of the tree
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
of <code>IIOMetadataNode</code> objects.  This string contains a version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
number, e.g. "javax_imageio_jpeg_image_1.0".  Readers and writers may
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
support multiple versions of the same basic format and the Image I/O
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
API has methods that allow specifying which version to use by passing
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
the string to the method/constructor used to obtain an <code>IIOMetadata</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
object.  In some cases, a more recent version may not be strictly
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
compatible with a program written expecting an older version (for
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
an example, see the Native Metadata Format section of the JPEG Metadata
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
Usage Notes below).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
Plug-ins may choose to support a <A
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
HREF="doc-files/standard_metadata.html">standard (plug-in neutral)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
format</A>.  This format does not provide lossless encoding of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
metadata, but allows a portion of the metadata to be accessed in a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
generic manner.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
Each of the standard plug-ins supports a so-called "native" metadata
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
format, which encodes its metadata losslessly:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
<ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
<li>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
<A HREF="doc-files/gif_metadata.html">
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
GIF metadata
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
</A>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
<li>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
<A HREF="doc-files/jpeg_metadata.html">
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
JPEG metadata
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
</A>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
<li>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
<A HREF="doc-files/png_metadata.html">
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
PNG metadata
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
</A>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
<li>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
<A HREF="doc-files/bmp_metadata.html">
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
BMP metadata
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
</A>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
<li>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
<A HREF="doc-files/wbmp_metadata.html">
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
WBMP metadata
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
</A>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
</ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
@since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
</body>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
</html>