jdk/src/share/classes/javax/imageio/stream/package.html
author bae
Fri, 08 May 2009 15:57:33 +0400
changeset 3448 1ccef37a150f
parent 2 90ce3da70b43
child 5506 202f599c92aa
permissions -rw-r--r--
6657133: Mutable statics in imageio plugins (findbugs) Reviewed-by: prr
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
<!--
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
Copyright 2000 Sun Microsystems, Inc.  All Rights Reserved.
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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
published by the Free Software Foundation.  Sun designates this
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
particular file as subject to the "Classpath" exception as provided
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
by Sun in the LICENSE file that accompanied this code.
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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
have any questions.
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 low-level I/O from
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
files and streams.
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
The <code>ImageInputStream</code> interface unifies streaming and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
file-based operations.  An abstract base class,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
<code>ImageInputStreamImpl</code> is provided to simplify writing
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
a new <code>ImageInputStream</code> class.  Concrete implementation
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
classes (<code>FileImageInputStream</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
<code>FileCacheImageInputStream</code>, and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
<code>MemoryCacheImageInputStream</code>) are provided that allow
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
input to come from a <code>File</code> or <code>InputStream</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
with or without the use of a temporary cache file.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
The <code>ImageOutputStream</code> interface performs an analogous
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
function for output.  An abstract base class,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
<code>ImageOutputStreamImpl</code> is provided, along with
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
concrete implementation classes (<code>FileImageOutputStream</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
<code>FileCacheImageOutputStream</code>, and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
<code>MemoryCacheImageOutputStream</code>) are provided that allow
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
output to go to a <code>File</code> or <code>OutputStream</code> with
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
or without the use of a temporary cache file.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
The <code>IIOByteBuffer</code> class provides an alternative way to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
perform reads of sequences of bytes that reduces the amount of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
internal data copying.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
@since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
</body>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
</html>