OpenJDK 27 · javax.imageio.stream.ImageOutputStream · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	flushBefore(long a `long` containing the length of the stream prefix that may be flushed to the destination. pos) Redeclares javax.imageio.stream.ImageInputStream.flushBefore. Flushes all data prior to the given position to the underlying destination, such as an `OutputStream` or `File`.
public void	write(int an `int` whose lower 8 bits are to be written. b) Redeclares java.io.DataOutput.write. Writes a single byte to the stream at the current position.
public void	write(byte[] an array of `byte`s to be written. b) Redeclares java.io.DataOutput.write. Writes a sequence of bytes to the stream at the current position.
public void	write(byte[] an array of `byte`s to be written. b, int the start offset in the data. off, int the number of `byte`s to write. len) Redeclares java.io.DataOutput.write. Writes a sequence of bytes to the stream at the current position.
public void	writeBit(int an `int` whose least significant bit is to be written to the stream. 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.
public void	writeBits(long a `long` containing the bits to be written, starting with the bit in position `numBits - 1` down to the least significant bit. bits, int an `int` between 0 and 64, inclusive. 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.
public void	writeBoolean(boolean the `boolean` to be written. v) Redeclares java.io.DataOutput.writeBoolean. Writes a `boolean` value to the stream.
public void	writeByte(int an `int` containing the byte value to be written. v) Redeclares java.io.DataOutput.writeByte. Writes the 8 low-order bits of `v` to the stream.
public void	writeBytes(String a `String` containing the value to be written. s) Redeclares java.io.DataOutput.writeBytes. Writes a string to the output stream.
public void	writeChar(int an `int` containing the char (unsigned short) value to be written. v) Redeclares java.io.DataOutput.writeChar. This method is a synonym for `writeShort`.
public void	writeChars(String a `String` containing the value to be written. s) Redeclares java.io.DataOutput.writeChars. Writes a string to the output stream.
public void	writeChars(char[] an array of `char`s to be written. c, int the start offset in the data. off, int the number of `char`s to write. len) Writes a sequence of chars to the stream at the current position.
public void	writeDouble(double a `double` containing the value to be written. v) Redeclares java.io.DataOutput.writeDouble. Writes a `double` value, which is comprised of four bytes, to the output stream.
public void	writeDoubles(double[] an array of `doubles`s to be written. d, int the start offset in the data. off, int the number of `double`s to write. len) Writes a sequence of doubles to the stream at the current position.
public void	writeFloat(float a `float` containing the value to be written. v) Redeclares java.io.DataOutput.writeFloat. Writes a `float` value, which is comprised of four bytes, to the output stream.
public void	writeFloats(float[] an array of `float`s to be written. f, int the start offset in the data. off, int the number of `float`s to write. len) Writes a sequence of floats to the stream at the current position.
public void	writeInt(int an `int` containing the value to be written. v) Redeclares java.io.DataOutput.writeInt. Writes the 32 bits of `v` to the stream.
public void	writeInts(int[] an array of `int`s to be written. i, int the start offset in the data. off, int the number of `int`s to write. len) Writes a sequence of ints to the stream at the current position.
public void	writeLong(long a `long` containing the value to be written. v) Redeclares java.io.DataOutput.writeLong. Writes the 64 bits of `v` to the stream.
public void	writeLongs(long[] an array of `long`s to be written. l, int the start offset in the data. off, int the number of `long`s to write. len) Writes a sequence of longs to the stream at the current position.
public void	writeShort(int an `int` containing the short value to be written. v) Redeclares java.io.DataOutput.writeShort. Writes the 16 low-order bits of `v` to the stream.
public void	writeShorts(short[] an array of `short`s to be written. s, int the start offset in the data. off, int the number of `short`s to write. len) Writes a sequence of shorts to the stream at the current position.
public void	writeUTF(String a `String` containing the value to be written. s) Redeclares java.io.DataOutput.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`.

Method Detail

flushBefore back to summary

flushBefore	back to summary
public void flushBefore(long pos) throws IOException Redeclares javax.imageio.stream.ImageInputStream.flushBefore. Flushes all data prior to the given position to the underlying destination, such as an `OutputStream` or `File`. Attempting to seek to the flushed portion of the stream will result in an `IndexOutOfBoundsException`. Parameters pos:long a `long` containing the length of the stream prefix that may be flushed to the destination. Exceptions IOException: if an I/O error occurs. IndexOutOfBoundsException: if `pos` lies in the flushed portion of the stream or past the current stream position.

public void flushBefore(long pos) throws IOException

Redeclares javax.imageio.stream.ImageInputStream.flushBefore.

Flushes all data prior to the given position to the underlying destination, such as an OutputStream or File. Attempting to seek to the flushed portion of the stream will result in an IndexOutOfBoundsException.

Parameters

pos:long: a long containing the length of the stream prefix that may be flushed to the destination.

Exceptions

IOException:: if an I/O error occurs.
IndexOutOfBoundsException:: if pos lies in the flushed portion of the stream or past the current stream position.

write back to summary

write	back to summary
public void write(int b) throws IOException Redeclares java.io.DataOutput.write. Writes a single byte to the stream at the current position. The 24 high-order bits of `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. Parameters b:int an `int` whose lower 8 bits are to be written. Exceptions IOException: if an I/O error occurs.

public void write(int b) throws IOException

Redeclares java.io.DataOutput.write.

Writes a single byte to the stream at the current position. The 24 high-order bits of 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.

Parameters

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

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(byte[] b) throws IOException Redeclares java.io.DataOutput.write. Writes a sequence of bytes to the stream at the current position. If `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. Parameters b:byte[] an array of `byte`s to be written. Exceptions IOException: if an I/O error occurs. NullPointerException: if `b` is `null`.

public void write(byte[] b) throws IOException

Redeclares java.io.DataOutput.write.

Writes a sequence of bytes to the stream at the current position. If 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.

Parameters

b:byte[]: an array of bytes to be written.

Exceptions

IOException:: if an I/O error occurs.
NullPointerException:: if b is null.

write back to summary

write	back to summary
public void write(byte[] b, int off, int len) throws IOException Redeclares java.io.DataOutput.write. Writes a sequence of bytes to the stream at the current position. If `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. Parameters b:byte[] an array of `byte`s to be written. off:int the start offset in the data. len:int the number of `byte`s to write. Exceptions IOException: if an I/O error occurs. IndexOutOfBoundsException: if `off` is negative, `len` is negative, or `off + len` is greater than `b.length`. NullPointerException: if `b` is `null`.

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

Redeclares java.io.DataOutput.write.

Writes a sequence of bytes to the stream at the current position. If len is 0, nothing is written. The byte b[off] is written first, then the byte b[off + 1], and so on.

Parameters

b:byte[]: an array of bytes to be written.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Exceptions

IOException:: if an I/O error occurs.
IndexOutOfBoundsException:: if off is negative, len is negative, or off + len is greater than b.length.
NullPointerException:: if b is null.

writeBit back to summary

writeBit	back to summary
public void writeBit(int bit) throws IOException 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. The upper 31 bits of the argument are ignored. The given bit replaces the previous bit at that position. The bit offset is advanced by one and reduced modulo 8. 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. Parameters bit:int an `int` whose least significant bit is to be written to the stream. Exceptions IOException: if an I/O error occurs.

public void writeBit(int bit) throws IOException

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. The upper 31 bits of the argument are ignored. The given bit replaces the previous bit at that position. The bit offset is advanced by one and reduced modulo 8.

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.

Parameters

bit:int: an int whose least significant bit is to be written to the stream.

Exceptions

IOException:: if an I/O error occurs.

writeBits back to summary

writeBits	back to summary
public void writeBits(long bits, int numBits) throws IOException 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. 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. Parameters bits:long a `long` containing the bits to be written, starting with the bit in position `numBits - 1` down to the least significant bit. numBits:int an `int` between 0 and 64, inclusive. Exceptions IOException: if an I/O error occurs. IllegalArgumentException: if `numBits` is not between 0 and 64, inclusive.

public void writeBits(long bits, int numBits) throws IOException

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. 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.

Parameters

bits:long: a long containing the bits to be written, starting with the bit in position numBits - 1 down to the least significant bit.
numBits:int: an int between 0 and 64, inclusive.

Exceptions

IOException:: if an I/O error occurs.
IllegalArgumentException:: if numBits is not between 0 and 64, inclusive.

writeBoolean back to summary

writeBoolean	back to summary
public void writeBoolean(boolean v) throws IOException Redeclares java.io.DataOutput.writeBoolean. Writes a `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. Parameters v:boolean the `boolean` to be written. Exceptions IOException: if an I/O error occurs.

public void writeBoolean(boolean v) throws IOException

Redeclares java.io.DataOutput.writeBoolean.

Writes a 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.

Parameters

v:boolean: the boolean to be written.

Exceptions

IOException:: if an I/O error occurs.

writeByte back to summary

writeByte	back to summary
public void writeByte(int v) throws IOException Redeclares java.io.DataOutput.writeByte. Writes the 8 low-order bits of `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. Parameters v:int an `int` containing the byte value to be written. Exceptions IOException: if an I/O error occurs.

public void writeByte(int v) throws IOException

Redeclares java.io.DataOutput.writeByte.

Writes the 8 low-order bits of 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.

Parameters

v:int: an int containing the byte value to be written.

Exceptions

IOException:: if an I/O error occurs.

writeBytes back to summary

writeBytes	back to summary
public void writeBytes(String s) throws IOException Redeclares java.io.DataOutput.writeBytes. Writes a string to the output stream. For every character in the string `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. Parameters s:String a `String` containing the value to be written. Exceptions IOException: if an I/O error occurs. NullPointerException: if `s` is `null`.

public void writeBytes(String s) throws IOException

Redeclares java.io.DataOutput.writeBytes.

Writes a string to the output stream. For every character in the string 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.

Parameters

s:String: a String containing the value to be written.

Exceptions

IOException:: if an I/O error occurs.
NullPointerException:: if s is null.

writeChar back to summary

writeChar	back to summary
public void writeChar(int v) throws IOException Redeclares java.io.DataOutput.writeChar. This method is a synonym for `writeShort`. Parameters v:int an `int` containing the char (unsigned short) value to be written. Exceptions IOException: if an I/O error occurs. See Also `writeShort(int)`

public void writeChar(int v) throws IOException

Redeclares java.io.DataOutput.writeChar.

This method is a synonym for writeShort.

Parameters

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

Exceptions

IOException:: if an I/O error occurs.

See Also

writeShort(int)

writeChars back to summary

writeChars	back to summary
public void writeChars(String s) throws IOException Redeclares java.io.DataOutput.writeChars. Writes a string to the output stream. For every character in the string `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. Parameters s:String a `String` containing the value to be written. Exceptions IOException: if an I/O error occurs. NullPointerException: if `s` is `null`.

public void writeChars(String s) throws IOException

Redeclares java.io.DataOutput.writeChars.

Writes a string to the output stream. For every character in the string 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.

Parameters

s:String: a String containing the value to be written.

Exceptions

IOException:: if an I/O error occurs.
NullPointerException:: if s is null.

writeChars back to summary

writeChars	back to summary
public void writeChars(char[] c, int off, int len) throws IOException Writes a sequence of chars to the stream at the current position. If `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. Parameters c:char[] an array of `char`s to be written. off:int the start offset in the data. len:int the number of `char`s to write. Exceptions IOException: if an I/O error occurs. IndexOutOfBoundsException: if `off` is negative, `len` is negative, or `off + len` is greater than `c.length`. NullPointerException: if `c` is `null`.

public void writeChars(char[] c, int off, int len) throws IOException

Writes a sequence of chars to the stream at the current position. If 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.

Parameters

c:char[]: an array of chars to be written.
off:int: the start offset in the data.
len:int: the number of chars to write.

Exceptions

IOException:: if an I/O error occurs.
IndexOutOfBoundsException:: if off is negative, len is negative, or off + len is greater than c.length.
NullPointerException:: if c is null.

writeDouble back to summary

writeDouble	back to summary
public void writeDouble(double v) throws IOException Redeclares java.io.DataOutput.writeDouble. Writes a `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. Parameters v:double a `double` containing the value to be written. Exceptions IOException: if an I/O error occurs.

public void writeDouble(double v) throws IOException

Redeclares java.io.DataOutput.writeDouble.

Writes a 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.

Parameters

v:double: a double containing the value to be written.

Exceptions

IOException:: if an I/O error occurs.

writeDoubles back to summary

writeDoubles	back to summary
public void writeDoubles(double[] d, int off, int len) throws IOException Writes a sequence of doubles to the stream at the current position. If `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. Parameters d:double[] an array of `doubles`s to be written. off:int the start offset in the data. len:int the number of `double`s to write. Exceptions IOException: if an I/O error occurs. IndexOutOfBoundsException: if `off` is negative, `len` is negative, or `off + len` is greater than `d.length`. NullPointerException: if `d` is `null`.

public void writeDoubles(double[] d, int off, int len) throws IOException

Writes a sequence of doubles to the stream at the current position. If 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.

Parameters

d:double[]: an array of doubless to be written.
off:int: the start offset in the data.
len:int: the number of doubles to write.

Exceptions

IOException:: if an I/O error occurs.
IndexOutOfBoundsException:: if off is negative, len is negative, or off + len is greater than d.length.
NullPointerException:: if d is null.

writeFloat back to summary

writeFloat	back to summary
public void writeFloat(float v) throws IOException Redeclares java.io.DataOutput.writeFloat. Writes a `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. Parameters v:float a `float` containing the value to be written. Exceptions IOException: if an I/O error occurs.

public void writeFloat(float v) throws IOException

Redeclares java.io.DataOutput.writeFloat.

Writes a 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.

Parameters

v:float: a float containing the value to be written.

Exceptions

IOException:: if an I/O error occurs.

writeFloats back to summary

writeFloats	back to summary
public void writeFloats(float[] f, int off, int len) throws IOException Writes a sequence of floats to the stream at the current position. If `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. Parameters f:float[] an array of `float`s to be written. off:int the start offset in the data. len:int the number of `float`s to write. Exceptions IOException: if an I/O error occurs. IndexOutOfBoundsException: if `off` is negative, `len` is negative, or `off + len` is greater than `f.length`. NullPointerException: if `f` is `null`.

public void writeFloats(float[] f, int off, int len) throws IOException

Writes a sequence of floats to the stream at the current position. If 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.

Parameters

f:float[]: an array of floats to be written.
off:int: the start offset in the data.
len:int: the number of floats to write.

Exceptions

IOException:: if an I/O error occurs.
IndexOutOfBoundsException:: if off is negative, len is negative, or off + len is greater than f.length.
NullPointerException:: if f is null.

writeInt back to summary

writeInt	back to summary
public void writeInt(int v) throws IOException Redeclares java.io.DataOutput.writeInt. Writes the 32 bits of `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) 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. Parameters v:int an `int` containing the value to be written. Exceptions IOException: if an I/O error occurs.

public void writeInt(int v) throws IOException

Redeclares java.io.DataOutput.writeInt.

Writes the 32 bits of 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)

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.

Parameters

v:int: an int containing the value to be written.

Exceptions

IOException:: if an I/O error occurs.

writeInts back to summary

writeInts	back to summary
public void writeInts(int[] i, int off, int len) throws IOException Writes a sequence of ints to the stream at the current position. If `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. Parameters i:int[] an array of `int`s to be written. off:int the start offset in the data. len:int the number of `int`s to write. Exceptions IOException: if an I/O error occurs. IndexOutOfBoundsException: if `off` is negative, `len` is negative, or `off + len` is greater than `i.length`. NullPointerException: if `i` is `null`.

public void writeInts(int[] i, int off, int len) throws IOException

Writes a sequence of ints to the stream at the current position. If 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.

Parameters

i:int[]: an array of ints to be written.
off:int: the start offset in the data.
len:int: the number of ints to write.

Exceptions

IOException:: if an I/O error occurs.
IndexOutOfBoundsException:: if off is negative, len is negative, or off + len is greater than i.length.
NullPointerException:: if i is null.

writeLong back to summary

writeLong	back to summary
public void writeLong(long v) throws IOException Redeclares java.io.DataOutput.writeLong. Writes the 64 bits of `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. Parameters v:long a `long` containing the value to be written. Exceptions IOException: if an I/O error occurs.

public void writeLong(long v) throws IOException

Redeclares java.io.DataOutput.writeLong.

Writes the 64 bits of 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.

Parameters

v:long: a long containing the value to be written.

Exceptions

IOException:: if an I/O error occurs.

writeLongs back to summary

writeLongs	back to summary
public void writeLongs(long[] l, int off, int len) throws IOException Writes a sequence of longs to the stream at the current position. If `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. Parameters l:long[] an array of `long`s to be written. off:int the start offset in the data. len:int the number of `long`s to write. Exceptions IOException: if an I/O error occurs. IndexOutOfBoundsException: if `off` is negative, `len` is negative, or `off + len` is greater than `l.length`. NullPointerException: if `l` is `null`.

public void writeLongs(long[] l, int off, int len) throws IOException

Writes a sequence of longs to the stream at the current position. If 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.

Parameters

l:long[]: an array of longs to be written.
off:int: the start offset in the data.
len:int: the number of longs to write.

Exceptions

IOException:: if an I/O error occurs.
IndexOutOfBoundsException:: if off is negative, len is negative, or off + len is greater than l.length.
NullPointerException:: if l is null.

writeShort back to summary

writeShort	back to summary
public void writeShort(int v) throws IOException Redeclares java.io.DataOutput.writeShort. Writes the 16 low-order bits of `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. Parameters v:int an `int` containing the short value to be written. Exceptions IOException: if an I/O error occurs.

public void writeShort(int v) throws IOException

Redeclares java.io.DataOutput.writeShort.

Writes the 16 low-order bits of 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.

Parameters

v:int: an int containing the short value to be written.

Exceptions

IOException:: if an I/O error occurs.

writeShorts back to summary

writeShorts	back to summary
public void writeShorts(short[] s, int off, int len) throws IOException Writes a sequence of shorts to the stream at the current position. If `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. Parameters s:short[] an array of `short`s to be written. off:int the start offset in the data. len:int the number of `short`s to write. Exceptions IOException: if an I/O error occurs. IndexOutOfBoundsException: if `off` is negative, `len` is negative, or `off + len` is greater than `s.length`. NullPointerException: if `s` is `null`.

public void writeShorts(short[] s, int off, int len) throws IOException

Writes a sequence of shorts to the stream at the current position. If 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.

Parameters

s:short[]: an array of shorts to be written.
off:int: the start offset in the data.
len:int: the number of shorts to write.

Exceptions

IOException:: if an I/O error occurs.
IndexOutOfBoundsException:: if off is negative, len is negative, or off + len is greater than s.length.
NullPointerException:: if s is null.

writeUTF back to summary

writeUTF	back to summary
public void writeUTF(String s) throws IOException Redeclares java.io.DataOutput.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`. 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. Parameters s:String a `String` containing the value to be written. Exceptions IOException: if an I/O error occurs. NullPointerException: if `s` is `null`. UTFDataFormatException: if the modified UTF-8 representation of `s` requires more than 65536 bytes.

public void writeUTF(String s) throws IOException

Redeclares java.io.DataOutput.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. 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.

Parameters

s:String: a String containing the value to be written.

Exceptions

IOException:: if an I/O error occurs.
NullPointerException:: if s is null.
UTFDataFormatException:: if the modified UTF-8 representation of s requires more than 65536 bytes.

public Interface ImageOutputStream

Method Summary

Method Detail