|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
, DataOutput
, ImageInputStream

, FileImageOutputStream
, ImageOutputStreamImpl
, MemoryCacheImageOutputStream

public interface ImageOutputStream
, DataOutput

A seekable output stream interface for use by
ImageWriters. Various output destinations, such as
OutputStreams and Files, as well as
future fast I/O destinations may be "wrapped" by a suitable
implementation of this interface for use by the Image I/O API.
Unlike a standard OutputStream, ImageOutputStream
extends its counterpart, ImageInputStream. Thus it is
possible to read from the stream as it is being written. The same
seek and flush positions apply to both reading and writing, although
the semantics for dealing with a non-zero bit offset before a byte-aligned
write are necessarily different from the semantics for dealing with
a non-zero bit offset before a byte-aligned read. When reading bytes,
any bit offset is set to 0 before the read; when writing bytes, a
non-zero bit offset causes the remaining bits in the byte to be written
as 0s. The byte-aligned write then starts at the next byte position.
ImageInputStream

| Method Summary | |
|---|---|
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 sequence of bytes to the stream at the current position. |
void |
write
Writes a single byte 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 . |
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 inherited from interface javax.imageio.stream.ImageInputStream ![]() |
|---|
close |
| Method Detail |
|---|

void write(int b)
throws IOException

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

b - an int whose lower 8 bits are to be
written.
IOException

- if an I/O error occurs.

void write(byte[] b)
throws IOException

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

b - an array of bytes to be written.
NullPointerException

- if b is
null.
IOException

- if an I/O error occurs.

void write(byte[] b,
int off,
int len)
throws IOException

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

b - an array of bytes to be written.off - the start offset in the data.len - the number of bytes to write.
IndexOutOfBoundsException

- if off is
negative, len is negative, or off +
len is greater than b.length.
NullPointerException

- if b is
null.
IOException

- if an I/O error occurs.

void writeBoolean(boolean v)
throws IOException

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

v - the boolean to be written.
IOException

- if an I/O error occurs.

void writeByte(int v)
throws IOException

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

v - an int containing the byte value to be
written.
IOException

- if an I/O error occurs.

void writeShort(int v)
throws IOException

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

v - an int containing the short value to be
written.
IOException

- if an I/O error occurs.

void writeChar(int v)
throws IOException

writeShort
.
writeChar

in interface DataOutput

v - an int containing the char (unsigned
short) value to be written.
IOException

- if an I/O error occurs.writeShort(int)


void writeInt(int v)
throws IOException

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

v - an int containing the value to be
written.
IOException

- if an I/O error occurs.

void writeLong(long v)
throws IOException

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

v - a long containing the value to be
written.
IOException

- if an I/O error occurs.

void writeFloat(float v)
throws IOException

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

v - a float containing the value to be
written.
IOException

- if an I/O error occurs.

void writeDouble(double v)
throws IOException

double value, which is comprised of four
bytes, to the output stream. It does this as if it first
converts this double value to an 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

v - a double containing the value to be
written.
IOException

- if an I/O error occurs.

void writeBytes(String![]()
![]()
s) throws IOException
![]()
![]()
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
