Closeable
, DataInput
, DataOutput
, AutoCloseable
, ImageInputStream
, ImageOutputStream
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.bitOffset, byteOrder, flushedPos, streamPos
Constructor | Description |
---|---|
ImageOutputStreamImpl() |
Constructs an
ImageOutputStreamImpl . |
Modifier and Type | Method | Description |
---|---|---|
protected 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(byte[] b) |
Writes a sequence of bytes to the stream at the current
position.
|
abstract void |
write(byte[] b,
int off,
int len) |
Writes a sequence of bytes to the stream at the current
position.
|
abstract void |
write(int b) |
Writes a single byte to the stream at the current position.
|
void |
writeBit(int bit) |
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(long bits,
int numBits) |
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(boolean v) |
Writes a
boolean value to the stream. |
void |
writeByte(int v) |
Writes the 8 low-order bits of
v to the
stream. |
void |
writeBytes(String s) |
Writes a string to the output stream.
|
void |
writeChar(int v) |
This method is a synonym for
writeShort . |
void |
writeChars(char[] c,
int off,
int len) |
Writes a sequence of chars to the stream at the current
position.
|
void |
writeChars(String s) |
Writes a string to the output stream.
|
void |
writeDouble(double v) |
Writes a
double value, which is comprised of four
bytes, to the output stream. |
void |
writeDoubles(double[] d,
int off,
int len) |
Writes a sequence of doubles to the stream at the current
position.
|
void |
writeFloat(float v) |
Writes a
float value, which is comprised of four
bytes, to the output stream. |
void |
writeFloats(float[] f,
int off,
int len) |
Writes a sequence of floats to the stream at the current
position.
|
void |
writeInt(int v) |
Writes the 32 bits of
v to the stream. |
void |
writeInts(int[] i,
int off,
int len) |
Writes a sequence of ints to the stream at the current
position.
|
void |
writeLong(long v) |
Writes the 64 bits of
v to the stream. |
void |
writeLongs(long[] l,
int off,
int len) |
Writes a sequence of longs to the stream at the current
position.
|
void |
writeShort(int v) |
Writes the 16 low-order bits of
v to the
stream. |
void |
writeShorts(short[] s,
int off,
int len) |
Writes a sequence of shorts to the stream at the current
position.
|
void |
writeUTF(String s) |
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 . |
close, flush, 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
checkClosed, close, finalize, 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
flushBefore
public ImageOutputStreamImpl()
ImageOutputStreamImpl
.public abstract void write(int b) throws IOException
ImageOutputStream
b
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 of ImageOutputStreamImpl
to guarantee this.
write
in interface DataOutput
write
in interface ImageOutputStream
b
- an int
whose lower 8 bits are to be
written.IOException
- if an I/O error occurs.public void write(byte[] b) throws IOException
ImageOutputStream
b.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.
write
in interface DataOutput
write
in interface ImageOutputStream
b
- an array of byte
s to be written.IOException
- if an I/O error occurs.public abstract void write(byte[] b, int off, int len) throws IOException
ImageOutputStream
len
is 0, nothing is written.
The byte b[off]
is written first, then the byte
b[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 of ImageOutputStreamImpl
to guarantee this.
write
in interface DataOutput
write
in interface ImageOutputStream
b
- an array of byte
s to be written.off
- the start offset in the data.len
- the number of byte
s to write.IOException
- if an I/O error occurs.public void writeBoolean(boolean v) throws IOException
ImageOutputStream
boolean
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.
writeBoolean
in interface DataOutput
writeBoolean
in interface ImageOutputStream
v
- the boolean
to be written.IOException
- if an I/O error occurs.public void writeByte(int v) throws IOException
ImageOutputStream
v
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.
writeByte
in interface DataOutput
writeByte
in interface ImageOutputStream
v
- an int
containing the byte value to be
written.IOException
- if an I/O error occurs.public void writeShort(int v) throws IOException
ImageOutputStream
v
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.
writeShort
in interface DataOutput
writeShort
in interface ImageOutputStream
v
- an int
containing the short value to be
written.IOException
- if an I/O error occurs.public void writeChar(int v) throws IOException
ImageOutputStream
writeShort
.writeChar
in interface DataOutput
writeChar
in interface ImageOutputStream
v
- an int
containing the char (unsigned
short) value to be written.IOException
- if an I/O error occurs.ImageOutputStream.writeShort(int)
public void writeInt(int v) throws IOException
ImageOutputStream
v
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)Otheriwse, 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.
writeInt
in interface DataOutput
writeInt
in interface ImageOutputStream
v
- an int
containing the value to be
written.IOException
- if an I/O error occurs.public void writeLong(long v) throws IOException
ImageOutputStream
v
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.
writeLong
in interface DataOutput
writeLong
in interface ImageOutputStream
v
- a long
containing the value to be
written.IOException
- if an I/O error occurs.public void writeFloat(float v) throws IOException
ImageOutputStream
float
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.
writeFloat
in interface DataOutput
writeFloat
in interface ImageOutputStream
v
- a float
containing the value to be
written.IOException
- if an I/O error occurs.public void writeDouble(double v) throws IOException
ImageOutputStream
double
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.
writeDouble
in interface DataOutput
writeDouble
in interface ImageOutputStream
v
- a double
containing the value to be
written.IOException
- if an I/O error occurs.public void writeBytes(String s) throws IOException
ImageOutputStream
s
, 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.
writeBytes
in interface DataOutput
writeBytes
in interface ImageOutputStream
s
- a String
containing the value to be
written.IOException
- if an I/O error occurs.public void writeChars(String s) throws IOException
ImageOutputStream
s
, 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.
writeChars
in interface DataOutput
writeChars
in interface ImageOutputStream
s
- a String
containing the value to be
written.IOException
- if an I/O error occurs.public void writeUTF(String s) throws IOException
ImageOutputStream
s
.
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.
writeUTF
in interface DataOutput
writeUTF
in interface ImageOutputStream
s
- a String
containing the value to be
written.UTFDataFormatException
- if the modified UTF-8
representation of s
requires more than 65536 bytes.IOException
- if an I/O error occurs.public void writeShorts(short[] s, int off, int len) throws IOException
ImageOutputStream
len
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.
writeShorts
in interface ImageOutputStream
s
- an array of short
s to be written.off
- the start offset in the data.len
- the number of short
s to write.IOException
- if an I/O error occurs.public void writeChars(char[] c, int off, int len) throws IOException
ImageOutputStream
len
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.
writeChars
in interface ImageOutputStream
c
- an array of char
s to be written.off
- the start offset in the data.len
- the number of char
s to write.IOException
- if an I/O error occurs.public void writeInts(int[] i, int off, int len) throws IOException
ImageOutputStream
len
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.
writeInts
in interface ImageOutputStream
i
- an array of int
s to be written.off
- the start offset in the data.len
- the number of int
s to write.IOException
- if an I/O error occurs.public void writeLongs(long[] l, int off, int len) throws IOException
ImageOutputStream
len
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.
writeLongs
in interface ImageOutputStream
l
- an array of long
s to be written.off
- the start offset in the data.len
- the number of long
s to write.IOException
- if an I/O error occurs.public void writeFloats(float[] f, int off, int len) throws IOException
ImageOutputStream
len
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.
writeFloats
in interface ImageOutputStream
f
- an array of float
s to be written.off
- the start offset in the data.len
- the number of float
s to write.IOException
- if an I/O error occurs.public void writeDoubles(double[] d, int off, int len) throws IOException
ImageOutputStream
len
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.
writeDoubles
in interface ImageOutputStream
d
- an array of doubles
s to be written.off
- the start offset in the data.len
- the number of double
s to write.IOException
- if an I/O error occurs.public void writeBit(int bit) throws IOException
ImageOutputStream
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.
writeBit
in interface ImageOutputStream
bit
- an int
whose least significant bit
is to be written to the stream.IOException
- if an I/O error occurs.public void writeBits(long bits, int numBits) throws IOException
ImageOutputStream
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. 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.
writeBits
in interface ImageOutputStream
bits
- a long
containing the bits to be
written, starting with the bit in position numBits - 1
down to the least significant bit.numBits
- an int
between 0 and 64, inclusive.IOException
- if an I/O error occurs.protected final void flushBits() throws IOException
write(int)
and
write(byte[], int, int)
methods.IOException
- if an I/O error occurs. Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-internal+0-adhoc.mlchung.jdk9-jdeps