Class ImageOutputStreamImpl
- All Implemented Interfaces:
Closeable, DataInput, DataOutput, AutoCloseable, ImageInputStream, ImageOutputStream
- Direct Known Subclasses:
FileCacheImageOutputStream, FileImageOutputStream, MemoryCacheImageOutputStream
public abstract class ImageOutputStreamImpl extends ImageInputStreamImpl implements ImageOutputStream
ImageOutputStream interface. This class is designed to reduce the number of methods that must be implemented by subclasses.Field Summary
Fields declared in class ImageInputStreamImpl
bitOffset, byteOrder, flushedPos, streamPos | Modifier and Type | Field | Description |
|---|---|---|
protected int |
bitOffset |
The current bit offset within the stream. |
protected ByteOrder |
byteOrder |
The byte order of the stream as an instance of the enumeration class java.nio.ByteOrder, where ByteOrder.BIG_ENDIAN indicates network byte order and ByteOrder.LITTLE_ENDIAN indicates the reverse order. |
protected long |
flushedPos |
The position prior to which data may be discarded. |
protected long |
streamPos |
The current read position within the stream. |
Constructor Summary
| Constructor | Description |
|---|---|
ImageOutputStreamImpl() |
Constructs an ImageOutputStreamImpl. |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
protected final void |
flushBits() |
If the bit offset is non-zero, forces the remaining bits in the current byte to 0 and advances the stream position by one. |
void |
write |
Writes a sequence of bytes to the stream at the current position. |
void |
writeBit |
Writes a single bit, given by the least significant bit of the argument, to the stream at the current bit offset within the current byte position. |
void |
writeBits |
Writes a sequence of bits, given by the numBits least significant bits of the bits argument in left-to-right order, to the stream at the current bit offset within the current byte position. |
void |
writeBoolean |
Writes a boolean value to the stream. |
void |
writeByte |
Writes the 8 low-order bits of v to the stream. |
void |
writeBytes |
Writes a string to the output stream. |
void |
writeChar |
This method is a synonym for writeShort. |
void |
writeChars |
Writes a sequence of chars to the stream at the current position. |
void |
writeChars |
Writes a string to the output stream. |
void |
writeDouble |
Writes a double value, which is comprised of four bytes, to the output stream. |
void |
writeDoubles |
Writes a sequence of doubles to the stream at the current position. |
void |
writeFloat |
Writes a float value, which is comprised of four bytes, to the output stream. |
void |
writeFloats |
Writes a sequence of floats to the stream at the current position. |
void |
writeInt |
Writes the 32 bits of v to the stream. |
void |
writeInts |
Writes a sequence of ints to the stream at the current position. |
void |
writeLong |
Writes the 64 bits of v to the stream. |
void |
writeLongs |
Writes a sequence of longs to the stream at the current position. |
void |
writeShort |
Writes the 16 low-order bits of v to the stream. |
void |
writeShorts |
Writes a sequence of shorts to the stream at the current position. |
void |
writeUTF |
Writes two bytes of length information to the output stream in network byte order, followed by the modified UTF-8 representation of every character in the string s. |
Methods declared in class ImageInputStreamImpl
checkClosed, close, flush, flushBefore, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, isCached, isCachedFile, isCachedMemory, length, mark, read, read, 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 | Modifier and Type | Method | Description |
|---|---|---|
protected final void |
checkClosed() |
Throws an IOException if the stream has been closed. |
void |
close() |
Closes the stream. |
void |
flush() |
Discards the initial position of the stream prior to the current stream position. |
void |
flushBefore |
Discards the initial portion of the stream prior to the indicated position. |
int |
getBitOffset() |
Returns the current bit offset, as an integer between 0 and 7, inclusive. |
ByteOrder |
getByteOrder() |
Returns the byte order with which data values will be read from this stream as an instance of the java.nio.ByteOrder enumeration. |
long |
getFlushedPosition() |
Returns the earliest position in the stream to which seeking may be performed. |
long |
getStreamPosition() |
Returns the current byte position of the stream. |
boolean |
isCached() |
Default implementation returns false. |
boolean |
isCachedFile() |
Default implementation returns false. |
boolean |
isCachedMemory() |
Default implementation returns false. |
long |
length() |
Returns -1L to indicate that the stream has unknown length. |
void |
mark() |
Pushes the current stream position onto a stack of marked positions. |
abstract int |
read() |
Reads a single byte from the stream and returns it as an int between 0 and 255. |
int |
read |
A convenience method that calls read(b, 0, b.length). |
abstract int |
read |
Reads up to len bytes from the stream, and stores them into b starting at index off. |
int |
readBit() |
Reads a single bit from the stream and returns it as an int with the value 0 or 1. |
long |
readBits |
Reads a bitstring from the stream and returns it as a long, with the first bit read becoming the most significant bit of the output. |
boolean |
readBoolean() |
Reads a byte from the stream and returns a boolean value of true if it is nonzero, false if it is zero. |
byte |
readByte() |
Reads a byte from the stream and returns it as a byte value. |
void |
readBytes |
Reads up to len bytes from the stream, and modifies the supplied IIOByteBuffer to indicate the byte array, offset, and length where the data may be found. |
char |
readChar() |
Equivalent to readUnsignedShort, except that the result is returned using the char datatype. |
double |
readDouble() |
Reads 8 bytes from the stream, and (conceptually) concatenates them according to the current byte order and returns the result as a double. |
float |
readFloat() |
Reads 4 bytes from the stream, and (conceptually) concatenates them according to the current byte order and returns the result as a float. |
void |
readFully |
Reads b.length bytes from the stream, and stores them into b starting at index 0. |
void |
readFully |
Reads len bytes from the stream, and stores them into b starting at index off. |
void |
readFully |
Reads len chars (unsigned 16-bit integers) from the stream according to the current byte order, and stores them into c starting at index off. |
void |
readFully |
Reads len doubles (64-bit IEEE double-precision floats) from the stream according to the current byte order, and stores them into d starting at index off. |
void |
readFully |
Reads len floats (32-bit IEEE single-precision floats) from the stream according to the current byte order, and stores them into f starting at index off. |
void |
readFully |
Reads len ints (signed 32-bit integers) from the stream according to the current byte order, and stores them into i starting at index off. |
void |
readFully |
Reads len longs (signed 64-bit integers) from the stream according to the current byte order, and stores them into l starting at index off. |
void |
readFully |
Reads len shorts (signed 16-bit integers) from the stream according to the current byte order, and stores them into s starting at index off. |
int |
readInt() |
Reads 4 bytes from the stream, and (conceptually) concatenates them according to the current byte order and returns the result as an int. |
String |
readLine() |
Reads the next line of text from the input stream. |
long |
readLong() |
Reads 8 bytes from the stream, and (conceptually) concatenates them according to the current byte order and returns the result as a long. |
short |
readShort() |
Reads two bytes from the stream, and (conceptually) concatenates them according to the current byte order, and returns the result as a short value. |
int |
readUnsignedByte() |
Reads a byte from the stream, and (conceptually) converts it to an int, masks it with 0xff in order to strip off any sign-extension bits, and returns it as a byte value. |
long |
readUnsignedInt() |
Reads 4 bytes from the stream, and (conceptually) concatenates them according to the current byte order, converts the result to a long, masks it with 0xffffffffL in order to strip off any sign-extension bits, and returns the result as an unsigned long value. |
int |
readUnsignedShort() |
Reads two bytes from the stream, and (conceptually) concatenates them according to the current byte order, converts the resulting value to an int, masks it with 0xffff in order to strip off any sign-extension buts, and returns the result as an unsigned int value. |
String |
readUTF() |
Reads in a string that has been encoded using a modified UTF-8 format. |
void |
reset() |
Resets the current stream byte and bit positions from the stack of marked positions. |
void |
seek |
Sets the current stream position to the desired location. |
void |
setBitOffset |
Sets the bit offset to an integer between 0 and 7, inclusive. |
void |
setByteOrder |
Sets the desired byte order for future reads of data values from this stream. |
int |
skipBytes |
Advances the current stream position by calling seek(getStreamPosition() + n). |
long |
skipBytes |
Advances the current stream position by calling seek(getStreamPosition() + n). |
Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | Modifier and Type | Method | Description |
|---|---|---|
protected Object |
clone() |
Creates and returns a copy of this object. |
boolean |
equals |
Indicates whether some other object is "equal to" this one. |
protected void |
finalize() |
Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release. |
final Class |
getClass() |
Returns the runtime class of this Object. |
int |
hashCode() |
Returns a hash code value for this object. |
final void |
notify() |
Wakes up a single thread that is waiting on this object's monitor. |
final void |
notifyAll() |
Wakes up all threads that are waiting on this object's monitor. |
String |
toString() |
Returns a string representation of the object. |
final void |
wait() |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted. |
final void |
wait |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. |
final void |
wait |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. |
Methods declared in interface ImageOutputStream
flushBefore, write, write | Modifier and Type | Method | Description |
|---|---|---|
void |
flushBefore |
Flushes all data prior to the given position to the underlying destination, such as an OutputStream or File. |
void |
write |
Writes a sequence of bytes to the stream at the current position. |
void |
write |
Writes a single byte to the stream at the current position. |
Constructor Details
ImageOutputStreamImpl
public ImageOutputStreamImpl()
ImageOutputStreamImpl.Method Details
write
public void write(byte[] b) throws IOException
ImageOutputStreamb.length is 0, nothing is written. The byte b[0] is written first, then the byte b[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.
- Specified by:
-
writein interfaceDataOutput - Specified by:
-
writein interfaceImageOutputStream - Parameters:
-
b- an array ofbytes to be written. - Throws:
-
IOException- if an I/O error occurs.
writeBoolean
public void writeBoolean(boolean v) throws IOException
ImageOutputStreamboolean value to the stream. If v is true, the value (byte)1 is written; if v is false, the value (byte)0 is written. 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.
- Specified by:
-
writeBooleanin interfaceDataOutput - Specified by:
-
writeBooleanin interfaceImageOutputStream - Parameters:
-
v- thebooleanto be written. - Throws:
-
IOException- if an I/O error occurs.
writeByte
public void writeByte(int v) throws IOException
ImageOutputStreamv to the stream. The 24 high-order bits of v are ignored. (This means that writeByte does exactly the same thing as write for an integer argument.) 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.
- Specified by:
-
writeBytein interfaceDataOutput - Specified by:
-
writeBytein interfaceImageOutputStream - Parameters:
-
v- anintcontaining the byte value to be written. - Throws:
-
IOException- if an I/O error occurs.
writeShort
public void writeShort(int v) throws IOException
ImageOutputStreamv to the stream. The 16 high-order bits of v are ignored. If the stream uses network byte order, the bytes written, in order, will be: (byte)((v >> 8) & 0xff) (byte)(v & 0xff)Otherwise, the bytes written will be:
(byte)(v & 0xff) (byte)((v >> 8) & 0xff)
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.
- Specified by:
-
writeShortin interfaceDataOutput - Specified by:
-
writeShortin interfaceImageOutputStream - Parameters:
-
v- anintcontaining the short value to be written. - Throws:
-
IOException- if an I/O error occurs.
writeChar
public void writeChar(int v) throws IOException
ImageOutputStreamwriteShort.- Specified by:
-
writeCharin interfaceDataOutput - Specified by:
-
writeCharin interfaceImageOutputStream - Parameters:
-
v- anintcontaining the char (unsigned short) value to be written. - Throws:
-
IOException- if an I/O error occurs. - See Also:
writeInt
public void writeInt(int v) throws IOException
ImageOutputStreamv to the stream. If the stream uses network byte order, the bytes written, in order, will be: (byte)((v >> 24) & 0xff) (byte)((v >> 16) & 0xff) (byte)((v >> 8) & 0xff) (byte)(v & 0xff)Otherwise, the bytes written will be:
(byte)(v & 0xff) (byte)((v >> 8) & 0xff) (byte)((v >> 16) & 0xff) (byte)((v >> 24) & 0xff)
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.
- Specified by:
-
writeIntin interfaceDataOutput - Specified by:
-
writeIntin interfaceImageOutputStream - Parameters:
-
v- anintcontaining the value to be written. - Throws:
-
IOException- if an I/O error occurs.
writeLong
public void writeLong(long v) throws IOException
ImageOutputStreamv to the stream. If the stream uses network byte order, the bytes written, in order, will be: (byte)((v >> 56) & 0xff) (byte)((v >> 48) & 0xff) (byte)((v >> 40) & 0xff) (byte)((v >> 32) & 0xff) (byte)((v >> 24) & 0xff) (byte)((v >> 16) & 0xff) (byte)((v >> 8) & 0xff) (byte)(v & 0xff)Otherwise, the bytes written will be:
(byte)(v & 0xff) (byte)((v >> 8) & 0xff) (byte)((v >> 16) & 0xff) (byte)((v >> 24) & 0xff) (byte)((v >> 32) & 0xff) (byte)((v >> 40) & 0xff) (byte)((v >> 48) & 0xff) (byte)((v >> 56) & 0xff)
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.
- Specified by:
-
writeLongin interfaceDataOutput - Specified by:
-
writeLongin interfaceImageOutputStream - Parameters:
-
v- alongcontaining the value to be written. - Throws:
-
IOException- if an I/O error occurs.
writeFloat
public void writeFloat(float v) throws IOException
ImageOutputStreamfloat value, which is comprised of four bytes, to the output stream. It does this as if it first converts this float value to an int in exactly the manner of the Float.floatToIntBits method and then writes the int value in exactly the manner of the writeInt method. 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.
- Specified by:
-
writeFloatin interfaceDataOutput - Specified by:
-
writeFloatin interfaceImageOutputStream - Parameters:
-
v- afloatcontaining the value to be written. - Throws:
-
IOException- if an I/O error occurs.
writeDouble
public void writeDouble(double v) throws IOException
ImageOutputStreamdouble value, which is comprised of four bytes, to the output stream. It does this as if it first converts this double value to a long in exactly the manner of the Double.doubleToLongBits method and then writes the long value in exactly the manner of the writeLong method. 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.
- Specified by:
-
writeDoublein interfaceDataOutput - Specified by:
-
writeDoublein interfaceImageOutputStream - Parameters:
-
v- adoublecontaining the value to be written. - Throws:
-
IOException- if an I/O error occurs.
writeBytes
public void writeBytes(String s) throws IOException
ImageOutputStreams, taken in order, one byte is written to the output stream. If s is null, a NullPointerException is thrown. If s.length is zero, then no bytes are written. Otherwise, the character s[0] is written first, then s[1], and so on; the last character written is s[s.length-1]. For each character, one byte is written, the low-order byte, in exactly the manner of the writeByte method. The high-order eight bits of each character in the string 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.
- Specified by:
-
writeBytesin interfaceDataOutput - Specified by:
-
writeBytesin interfaceImageOutputStream - Parameters:
-
s- aStringcontaining the value to be written. - Throws:
-
IOException- if an I/O error occurs.
writeChars
public void writeChars(String s) throws IOException
ImageOutputStreams, taken in order, two bytes are written to the output stream, ordered according to the current byte order setting. If network byte order is being used, the high-order byte is written first; the order is reversed otherwise. If s is null, a NullPointerException is thrown. If s.length is zero, then no bytes are written. Otherwise, the character s[0] is written first, then s[1], and so on; the last character written is s[s.length-1].
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.
- Specified by:
-
writeCharsin interfaceDataOutput - Specified by:
-
writeCharsin interfaceImageOutputStream - Parameters:
-
s- aStringcontaining the value to be written. - Throws:
-
IOException- if an I/O error occurs.
writeUTF
public void writeUTF(String s) throws IOException
ImageOutputStreams. If s is null, a NullPointerException is thrown. Each character in the string s is converted to a group of one, two, or three bytes, depending on the value of the character. If a character c is in the range \u0001 through \u007f, it is represented by one byte:
(byte)c
If a character c is \u0000 or is in the range \u0080 through \u07ff, then it is represented by two bytes, to be written in the order shown:
(byte)(0xc0 | (0x1f & (c >> 6)))
(byte)(0x80 | (0x3f & c))
If a character c is in the range \u0800 through uffff, then it is represented by three bytes, to be written in the order shown:
(byte)(0xe0 | (0x0f & (c >> 12)))
(byte)(0x80 | (0x3f & (c >> 6)))
(byte)(0x80 | (0x3f & c))
First, the total number of bytes needed to represent all the characters of s is calculated. If this number is larger than 65535, then a UTFDataFormatException is thrown. Otherwise, this length is written to the output stream in exactly the manner of the writeShort method; after this, the one-, two-, or three-byte representation of each character in the string s is written.
The current byte order setting is 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.
Note: This method should not be used in the implementation of image formats that use standard UTF-8, because the modified UTF-8 used here is incompatible with standard UTF-8.
- Specified by:
-
writeUTFin interfaceDataOutput - Specified by:
-
writeUTFin interfaceImageOutputStream - Parameters:
-
s- aStringcontaining the value to be written. - Throws:
-
UTFDataFormatException- if the modified UTF-8 representation ofsrequires more than 65536 bytes. -
IOException- if an I/O error occurs.
writeShorts
public void writeShorts(short[] s, int off, int len) throws IOException
ImageOutputStreamlen is 0, nothing is written. The short s[off] is written first, then the short s[off + 1], and so on. The byte order of the stream is used to determine the order in which the individual bytes are written. 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.
- Specified by:
-
writeShortsin interfaceImageOutputStream - Parameters:
-
s- an array ofshorts to be written. -
off- the start offset in the data. -
len- the number ofshorts to write. - Throws:
-
IOException- if an I/O error occurs.
writeChars
public void writeChars(char[] c, int off, int len) throws IOException
ImageOutputStreamlen is 0, nothing is written. The char c[off] is written first, then the char c[off + 1], and so on. The byte order of the stream is used to determine the order in which the individual bytes are written. 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.
- Specified by:
-
writeCharsin interfaceImageOutputStream - Parameters:
-
c- an array ofchars to be written. -
off- the start offset in the data. -
len- the number ofchars to write. - Throws:
-
IOException- if an I/O error occurs.
writeInts
public void writeInts(int[] i, int off, int len) throws IOException
ImageOutputStreamlen is 0, nothing is written. The int i[off] is written first, then the int i[off + 1], and so on. The byte order of the stream is used to determine the order in which the individual bytes are written. 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.
- Specified by:
-
writeIntsin interfaceImageOutputStream - Parameters:
-
i- an array ofints to be written. -
off- the start offset in the data. -
len- the number ofints to write. - Throws:
-
IOException- if an I/O error occurs.
writeLongs
public void writeLongs(long[] l, int off, int len) throws IOException
ImageOutputStreamlen is 0, nothing is written. The long l[off] is written first, then the long l[off + 1], and so on. The byte order of the stream is used to determine the order in which the individual bytes are written. 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.
- Specified by:
-
writeLongsin interfaceImageOutputStream - Parameters:
-
l- an array oflongs to be written. -
off- the start offset in the data. -
len- the number oflongs to write. - Throws:
-
IOException- if an I/O error occurs.
writeFloats
public void writeFloats(float[] f, int off, int len) throws IOException
ImageOutputStreamlen is 0, nothing is written. The float f[off] is written first, then the float f[off + 1], and so on. The byte order of the stream is used to determine the order in which the individual bytes are written. 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.
- Specified by:
-
writeFloatsin interfaceImageOutputStream - Parameters:
-
f- an array offloats to be written. -
off- the start offset in the data. -
len- the number offloats to write. - Throws:
-
IOException- if an I/O error occurs.
writeDoubles
public void writeDoubles(double[] d, int off, int len) throws IOException
ImageOutputStreamlen is 0, nothing is written. The double d[off] is written first, then the double d[off + 1], and so on. The byte order of the stream is used to determine the order in which the individual bytes are written. 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.
- Specified by:
-
writeDoublesin interfaceImageOutputStream - Parameters:
-
d- an array ofdoubless to be written. -
off- the start offset in the data. -
len- the number ofdoubles to write. - Throws:
-
IOException- if an I/O error occurs.
writeBit
public void writeBit(int bit) throws IOException
ImageOutputStreamIf any bits of a particular byte have never been set at the time the byte is flushed to the destination, those bits will be set to 0 automatically.
- Specified by:
-
writeBitin interfaceImageOutputStream - Parameters:
-
bit- anintwhose least significant bit is to be written to the stream. - Throws:
-
IOException- if an I/O error occurs.
writeBits
public void writeBits(long bits, int numBits) throws IOException
ImageOutputStreamnumBits least significant bits of the bits argument in left-to-right order, to the stream at the current bit offset within the current byte position. The upper 64 - numBits bits of the argument are ignored. The bit offset is advanced by numBits and reduced modulo 8. Note that a bit offset of 0 always indicates the most-significant bit of the byte, and bytes of bits are written out in sequence as they are encountered. Thus bit writes are always effectively in network byte order. The actual stream byte order setting is ignored. Bit data may be accumulated in memory indefinitely, until flushBefore is called. At that time, all bit data prior to the flushed position will be written.
If any bits of a particular byte have never been set at the time the byte is flushed to the destination, those bits will be set to 0 automatically.
- Specified by:
-
writeBitsin interfaceImageOutputStream - Parameters:
-
bits- alongcontaining the bits to be written, starting with the bit in positionnumBits - 1down to the least significant bit. -
numBits- anintbetween 0 and 64, inclusive. - Throws:
-
IOException- if an I/O error occurs.
flushBits
protected final void flushBits() throws IOException
write(int) and write(byte[], int, int) methods.- Throws:
-
IOException- if an I/O error occurs.
© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.