- All Implemented Interfaces:
Closeable
,DataInput
,DataOutput
,AutoCloseable
,ImageInputStream
,ImageOutputStream
ImageOutputStream
that writes its
output to a regular OutputStream
. A memory buffer is
used to cache at least the data between the discard position and
the current write position. The only constructor takes an
OutputStream
, so this class may not be used for
read/modify/write operations. Reading can occur only on parts of
the stream that have already been written to the cache and not
yet flushed.-
Field Summary
Fields declared in class javax.imageio.stream.ImageInputStreamImpl
bitOffset, byteOrder, flushedPos, streamPos
-
Constructor Summary
ConstructorDescriptionConstructs aMemoryCacheImageOutputStream
that will write to a givenOutputStream
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes thisMemoryCacheImageOutputStream
.void
flushBefore
(long pos) Flushes all data prior to the given position to the underlying destination, such as anOutputStream
orFile
.boolean
isCached()
Returnstrue
since thisImageOutputStream
caches data in order to allow seeking backwards.boolean
Returnsfalse
since thisImageOutputStream
does not maintain a file cache.boolean
Returnstrue
since thisImageOutputStream
maintains a main memory cache.long
length()
Returns-1L
to indicate that the stream has unknown length.int
read()
Reads a single byte from the stream and returns it as anint
between 0 and 255.int
read
(byte[] b, int off, int len) Reads up tolen
bytes from the stream, and stores them intob
starting at indexoff
.void
write
(byte[] b, int off, int len) Writes a sequence of bytes to the stream at the current position.void
write
(int b) Writes a single byte to the stream at the current position.Methods declared in class javax.imageio.stream.ImageOutputStreamImpl
flushBits, write, writeBit, writeBits, writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeChars, writeDouble, writeDoubles, writeFloat, writeFloats, writeInt, writeInts, writeLong, writeLongs, writeShort, writeShorts, writeUTF
Methods declared in class javax.imageio.stream.ImageInputStreamImpl
checkClosed, finalize, flush, flushBefore, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, length, mark, read, readBit, readBits, readBoolean, readByte, readBytes, readChar, readDouble, readFloat, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTF, reset, seek, setBitOffset, setByteOrder, skipBytes, skipBytes
Methods declared in class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods declared in interface javax.imageio.stream.ImageInputStream
flush, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, mark, read, readBit, readBits, readBoolean, readByte, readBytes, readChar, readDouble, readFloat, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTF, reset, seek, setBitOffset, setByteOrder, skipBytes, skipBytes
-
Constructor Details
-
MemoryCacheImageOutputStream
Constructs aMemoryCacheImageOutputStream
that will write to a givenOutputStream
.- Parameters:
stream
- anOutputStream
to write to.- Throws:
IllegalArgumentException
- ifstream
isnull
.
-
-
Method Details
-
read
Description copied from class:ImageInputStreamImpl
Reads a single byte from the stream and returns it as anint
between 0 and 255. If EOF is reached,-1
is returned.Subclasses must provide an implementation for this method. The subclass implementation should update the stream position before exiting.
The bit offset within the stream must be reset to zero before the read occurs.
- Specified by:
read
in interfaceImageInputStream
- Specified by:
read
in classImageInputStreamImpl
- Returns:
- the value of the next byte in the stream, or
-1
if EOF is reached. - Throws:
IOException
- if the stream has been closed.
-
read
Description copied from class:ImageInputStreamImpl
Reads up tolen
bytes from the stream, and stores them intob
starting at indexoff
. If no bytes can be read because the end of the stream has been reached,-1
is returned.The bit offset within the stream must be reset to zero before the read occurs.
Subclasses must provide an implementation for this method. The subclass implementation should update the stream position before exiting.
- Specified by:
read
in interfaceImageInputStream
- Specified by:
read
in classImageInputStreamImpl
- Parameters:
b
- an array of bytes to be written to.off
- the starting position withinb
to write to.len
- the maximum number of bytes to read.- Returns:
- the number of bytes actually read, or
-1
to indicate EOF. - Throws:
IOException
- if an I/O error occurs.
-
write
Description copied from interface:ImageOutputStream
Writes a single byte to the stream at the current position. The 24 high-order bits ofb
are ignored.If the bit offset within the stream is non-zero, the remainder of the current byte is padded with 0s and written out first. The bit offset will be 0 after the write. Implementers can use the
flushBits
method ofImageOutputStreamImpl
to guarantee this.- Parameters:
b
- anint
whose lower 8 bits are to be written.- Throws:
IOException
- if an I/O error occurs.
-
write
Description copied from interface:ImageOutputStream
Writes a sequence of bytes to the stream at the current position. Iflen
is 0, nothing is written. The byteb[off]
is written first, then the byteb[off + 1]
, and so on.If the bit offset within the stream is non-zero, the remainder of the current byte is padded with 0s and written out first. The bit offset will be 0 after the write. Implementers can use the
flushBits
method ofImageOutputStreamImpl
to guarantee this.- Parameters:
b
- an array ofbyte
s to be written.off
- the start offset in the data.len
- the number ofbyte
s to write.- Throws:
IOException
- if an I/O error occurs.
-
length
public long length()Description copied from class:ImageInputStreamImpl
Returns-1L
to indicate that the stream has unknown length. Subclasses must override this method to provide actual length information.- Specified by:
length
in interfaceImageInputStream
- Overrides:
length
in classImageInputStreamImpl
- Returns:
- -1L to indicate unknown length.
-
isCached
public boolean isCached()Returnstrue
since thisImageOutputStream
caches data in order to allow seeking backwards.- Specified by:
isCached
in interfaceImageInputStream
- Overrides:
isCached
in classImageInputStreamImpl
- Returns:
true
.- See Also:
-
isCachedFile
public boolean isCachedFile()Returnsfalse
since thisImageOutputStream
does not maintain a file cache.- Specified by:
isCachedFile
in interfaceImageInputStream
- Overrides:
isCachedFile
in classImageInputStreamImpl
- Returns:
false
.- See Also:
-
isCachedMemory
public boolean isCachedMemory()Returnstrue
since thisImageOutputStream
maintains a main memory cache.- Specified by:
isCachedMemory
in interfaceImageInputStream
- Overrides:
isCachedMemory
in classImageInputStreamImpl
- Returns:
true
.- See Also:
-
close
Closes thisMemoryCacheImageOutputStream
. All pending data is flushed to the output, and the cache is released. The destinationOutputStream
is not closed.- Throws:
IOException
- if an I/O error occurs.
-
flushBefore
Description copied from interface:ImageOutputStream
Flushes all data prior to the given position to the underlying destination, such as anOutputStream
orFile
. Attempting to seek to the flushed portion of the stream will result in anIndexOutOfBoundsException
.- Parameters:
pos
- along
containing the length of the stream prefix that may be flushed to the destination.- Throws:
IOException
- if an I/O error occurs.
-