ImageOutputStreamImpl (Java 2 Platform SE 5.0) (original) (raw)

javax.imageio.stream

Class ImageOutputStreamImpl

java.lang.Object extended by javax.imageio.stream.ImageInputStreamImpl javax.imageio.stream.ImageOutputStreamImpl

All Implemented Interfaces:

DataInput, DataOutput, ImageInputStream, ImageOutputStream

Direct Known Subclasses:

FileCacheImageOutputStream, FileImageOutputStream, MemoryCacheImageOutputStream

public abstract class ImageOutputStreamImpl

extends ImageInputStreamImpl

implements ImageOutputStream

An abstract class implementing the ImageOutputStream interface. This class is designed to reduce the number of methods that must be implemented by subclasses.

Field Summary

Fields inherited from class javax.imageio.stream.ImageInputStreamImpl
bitOffset, byteOrder, flushedPos, streamPos

Constructor Summary
ImageOutputStreamImpl() Constructs an ImageOutputStreamImpl.

Method Summary
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 to the output stream all the bytes in array b.
abstract void	[write](../../../javax/imageio/stream/ImageOutputStreamImpl.html#write%28byte[], int, int%29)(byte[] b, int off, int len) Writes len bytes from arrayb, in order, to the output stream.
abstract void	write(int b) Writes to the output stream the eight low-order bits of the argument b.
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](../../../javax/imageio/stream/ImageOutputStreamImpl.html#writeBits%28long, int%29)(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 this output stream.
void	writeByte(int v) Writes to the output stream the eight low- order bits of the argument v.
void	writeBytes(String s) Writes a string to the output stream.
void	writeChar(int v) Writes a char value, which is comprised of two bytes, to the output stream.
void	[writeChars](../../../javax/imageio/stream/ImageOutputStreamImpl.html#writeChars%28char[], int, int%29)(char[] c, int off, int len) Writes a sequence of chars to the stream at the current position.
void	writeChars(String s) Writes every character in the string s, to the output stream, in order, two bytes per character.
void	writeDouble(double v) Writes a double value, which is comprised of eight bytes, to the output stream.
void	[writeDoubles](../../../javax/imageio/stream/ImageOutputStreamImpl.html#writeDoubles%28double[], int, int%29)(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](../../../javax/imageio/stream/ImageOutputStreamImpl.html#writeFloats%28float[], int, int%29)(float[] f, int off, int len) Writes a sequence of floats to the stream at the current position.
void	writeInt(int v) Writes an int value, which is comprised of four bytes, to the output stream.
void	[writeInts](../../../javax/imageio/stream/ImageOutputStreamImpl.html#writeInts%28int[], int, int%29)(int[] i, int off, int len) Writes a sequence of ints to the stream at the current position.
void	writeLong(long v) Writes a long value, which is comprised of eight bytes, to the output stream.
void	[writeLongs](../../../javax/imageio/stream/ImageOutputStreamImpl.html#writeLongs%28long[], int, int%29)(long[] l, int off, int len) Writes a sequence of longs to the stream at the current position.
void	writeShort(int v) Writes two bytes to the output stream to represent the value of the argument.
void	[writeShorts](../../../javax/imageio/stream/ImageOutputStreamImpl.html#writeShorts%28short[], int, int%29)(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, followed by themodified UTF-8 representation of every character in the string s.

Methods inherited from class javax.imageio.stream.ImageInputStreamImpl
checkClosed, close, finalize, flush, flushBefore, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, isCached, isCachedFile, isCachedMemory, length, mark, read, read, [read](../../../javax/imageio/stream/ImageInputStreamImpl.html#read%28byte[], int, int%29), readBit, readBits, readBoolean, readByte, [readBytes](../../../javax/imageio/stream/ImageInputStreamImpl.html#readBytes%28javax.imageio.stream.IIOByteBuffer, int%29), readChar, readDouble, readFloat, readFully, [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28byte[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28char[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28double[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28float[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28int[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28long[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28short[], int, int%29), readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTF, reset, seek, setBitOffset, setByteOrder, skipBytes, skipBytes

Methods inherited from class javax.imageio.stream.ImageInputStreamImpl

checkClosed, close, finalize, flush, flushBefore, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, isCached, isCachedFile, isCachedMemory, length, mark, read, read, [read](../../../javax/imageio/stream/ImageInputStreamImpl.html#read%28byte[], int, int%29), readBit, readBits, readBoolean, readByte, [readBytes](../../../javax/imageio/stream/ImageInputStreamImpl.html#readBytes%28javax.imageio.stream.IIOByteBuffer, int%29), readChar, readDouble, readFloat, readFully, [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28byte[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28char[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28double[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28float[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28int[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28long[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28short[], int, int%29), readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTF, reset, seek, setBitOffset, setByteOrder, skipBytes, skipBytes

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../java/lang/Object.html#wait%28long, int%29)

Methods inherited from interface javax.imageio.stream.ImageOutputStream
flushBefore

Methods inherited from interface javax.imageio.stream.ImageInputStream
close, flush, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, isCached, isCachedFile, isCachedMemory, length, mark, read, read, [read](../../../javax/imageio/stream/ImageInputStream.html#read%28byte[], int, int%29), readBit, readBits, readBoolean, readByte, [readBytes](../../../javax/imageio/stream/ImageInputStream.html#readBytes%28javax.imageio.stream.IIOByteBuffer, int%29), readChar, readDouble, readFloat, readFully, [readFully](../../../javax/imageio/stream/ImageInputStream.html#readFully%28byte[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStream.html#readFully%28char[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStream.html#readFully%28double[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStream.html#readFully%28float[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStream.html#readFully%28int[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStream.html#readFully%28long[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStream.html#readFully%28short[], int, int%29), readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTF, reset, seek, setBitOffset, setByteOrder, skipBytes, skipBytes

Methods inherited from interface javax.imageio.stream.ImageInputStream

close, flush, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, isCached, isCachedFile, isCachedMemory, length, mark, read, read, [read](../../../javax/imageio/stream/ImageInputStream.html#read%28byte[], int, int%29), readBit, readBits, readBoolean, readByte, [readBytes](../../../javax/imageio/stream/ImageInputStream.html#readBytes%28javax.imageio.stream.IIOByteBuffer, int%29), readChar, readDouble, readFloat, readFully, [readFully](../../../javax/imageio/stream/ImageInputStream.html#readFully%28byte[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStream.html#readFully%28char[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStream.html#readFully%28double[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStream.html#readFully%28float[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStream.html#readFully%28int[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStream.html#readFully%28long[], int, int%29), [readFully](../../../javax/imageio/stream/ImageInputStream.html#readFully%28short[], int, int%29), readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTF, reset, seek, setBitOffset, setByteOrder, skipBytes, skipBytes

Constructor Detail

ImageOutputStreamImpl

public ImageOutputStreamImpl()

Constructs an ImageOutputStreamImpl.

Method Detail

write

public abstract void write(int b) throws IOException

Description copied from interface: [DataOutput](../../../java/io/DataOutput.html#write%28int%29)

Writes to the output stream the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Specified by:

[write](../../../java/io/DataOutput.html#write%28int%29) in interface [DataOutput](../../../java/io/DataOutput.html "interface in java.io")

Specified by:

[write](../../../javax/imageio/stream/ImageOutputStream.html#write%28int%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

b - the byte to be written.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

write

public void write(byte[] b) throws IOException

Description copied from interface: [DataOutput](../../../java/io/DataOutput.html#write%28byte[]%29)

Writes to the output stream all the bytes in array b. If b is null, a NullPointerException is thrown. If b.length is zero, then no bytes are written. Otherwise, the byteb[0] is written first, thenb[1], and so on; the last byte written is b[b.length-1].

Specified by:

[write](../../../java/io/DataOutput.html#write%28byte[]%29) in interface [DataOutput](../../../java/io/DataOutput.html "interface in java.io")

Specified by:

[write](../../../javax/imageio/stream/ImageOutputStream.html#write%28byte[]%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

b - the data.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

write

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

Description copied from interface: [DataOutput](../../../java/io/DataOutput.html#write%28byte[], int, int%29)

Writes len bytes from arrayb, in order, to the output stream. If b is null, a NullPointerException is thrown. If off is negative, or len is negative, or off+len is greater than the length of the arrayb, then an IndexOutOfBoundsException is thrown. If len is zero, then no bytes are written. Otherwise, the byte b[off] is written first, then b[off+1], and so on; the last byte written is b[off+len-1].

Specified by:

[write](../../../java/io/DataOutput.html#write%28byte[], int, int%29) in interface [DataOutput](../../../java/io/DataOutput.html "interface in java.io")

Specified by:

[write](../../../javax/imageio/stream/ImageOutputStream.html#write%28byte[], int, int%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeBoolean

public void writeBoolean(boolean v) throws IOException

Description copied from interface: [DataOutput](../../../java/io/DataOutput.html#writeBoolean%28boolean%29)

Writes a boolean value to this output stream. If the argument v is true, the value (byte)1 is written; if v is false, the value (byte)0 is written. The byte written by this method may be read by the readBoolean method of interface DataInput, which will then return a boolean equal to v.

Specified by:

[writeBoolean](../../../java/io/DataOutput.html#writeBoolean%28boolean%29) in interface [DataOutput](../../../java/io/DataOutput.html "interface in java.io")

Specified by:

[writeBoolean](../../../javax/imageio/stream/ImageOutputStream.html#writeBoolean%28boolean%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

v - the boolean to be written.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeByte

public void writeByte(int v) throws IOException

Description copied from interface: [DataOutput](../../../java/io/DataOutput.html#writeByte%28int%29)

Writes to the output stream the eight low- order bits of the argument v. The 24 high-order bits of v are ignored. (This means that writeByte does exactly the same thing as write for an integer argument.) The byte written by this method may be read by the readByte method of interface DataInput, which will then return a byte equal to (byte)v.

Specified by:

[writeByte](../../../java/io/DataOutput.html#writeByte%28int%29) in interface [DataOutput](../../../java/io/DataOutput.html "interface in java.io")

Specified by:

[writeByte](../../../javax/imageio/stream/ImageOutputStream.html#writeByte%28int%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

v - the byte value to be written.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeShort

public void writeShort(int v) throws IOException

Description copied from interface: [DataOutput](../../../java/io/DataOutput.html#writeShort%28int%29)

Writes two bytes to the output stream to represent the value of the argument. The byte values to be written, in the order shown, are:

(byte)(0xff & (v >> 8)) (byte)(0xff & v)

The bytes written by this method may be read by the readShort method of interface DataInput , which will then return a short equal to (short)v.

Specified by:

[writeShort](../../../java/io/DataOutput.html#writeShort%28int%29) in interface [DataOutput](../../../java/io/DataOutput.html "interface in java.io")

Specified by:

[writeShort](../../../javax/imageio/stream/ImageOutputStream.html#writeShort%28int%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

v - the short value to be written.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeChar

public void writeChar(int v) throws IOException

Description copied from interface: [DataOutput](../../../java/io/DataOutput.html#writeChar%28int%29)

Writes a char value, which is comprised of two bytes, to the output stream. The byte values to be written, in the order shown, are:


 (byte)(0xff & (v >> 8))
 (byte)(0xff & v)

The bytes written by this method may be read by the readChar method of interface DataInput , which will then return a char equal to (char)v.

Specified by:

[writeChar](../../../java/io/DataOutput.html#writeChar%28int%29) in interface [DataOutput](../../../java/io/DataOutput.html "interface in java.io")

Specified by:

[writeChar](../../../javax/imageio/stream/ImageOutputStream.html#writeChar%28int%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

v - the char value to be written.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

See Also:

ImageOutputStream.writeShort(int)

writeInt

public void writeInt(int v) throws IOException

Description copied from interface: [DataOutput](../../../java/io/DataOutput.html#writeInt%28int%29)

Writes an int value, which is comprised of four bytes, to the output stream. The byte values to be written, in the order shown, are:


 (byte)(0xff & (v >> 24))
 (byte)(0xff & (v >> 16))
 (byte)(0xff & (v >>    8))
 (byte)(0xff & v)

The bytes written by this method may be read by the readInt method of interfaceDataInput , which will then return an int equal to v.

Specified by:

[writeInt](../../../java/io/DataOutput.html#writeInt%28int%29) in interface [DataOutput](../../../java/io/DataOutput.html "interface in java.io")

Specified by:

[writeInt](../../../javax/imageio/stream/ImageOutputStream.html#writeInt%28int%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

v - the int value to be written.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeLong

public void writeLong(long v) throws IOException

Description copied from interface: [DataOutput](../../../java/io/DataOutput.html#writeLong%28long%29)

Writes a long value, which is comprised of eight bytes, to the output stream. The byte values to be written, in the order shown, are:


 (byte)(0xff & (v >> 56))
 (byte)(0xff & (v >> 48))
 (byte)(0xff & (v >> 40))
 (byte)(0xff & (v >> 32))
 (byte)(0xff & (v >> 24))
 (byte)(0xff & (v >> 16))
 (byte)(0xff & (v >>  8))
 (byte)(0xff & v)

The bytes written by this method may be read by the readLong method of interface DataInput , which will then return a long equal to v.

Specified by:

[writeLong](../../../java/io/DataOutput.html#writeLong%28long%29) in interface [DataOutput](../../../java/io/DataOutput.html "interface in java.io")

Specified by:

[writeLong](../../../javax/imageio/stream/ImageOutputStream.html#writeLong%28long%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

v - the long value to be written.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeFloat

public void writeFloat(float v) throws IOException

Description copied from interface: [DataOutput](../../../java/io/DataOutput.html#writeFloat%28float%29)

Writes a float value, which is comprised of four bytes, to the output stream. It does this as if it first converts thisfloat 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. The bytes written by this method may be read by the readFloat method of interface DataInput, which will then return a float equal to v.

Specified by:

[writeFloat](../../../java/io/DataOutput.html#writeFloat%28float%29) in interface [DataOutput](../../../java/io/DataOutput.html "interface in java.io")

Specified by:

[writeFloat](../../../javax/imageio/stream/ImageOutputStream.html#writeFloat%28float%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

v - the float value to be written.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeDouble

public void writeDouble(double v) throws IOException

Description copied from interface: [DataOutput](../../../java/io/DataOutput.html#writeDouble%28double%29)

Writes a double value, which is comprised of eight bytes, to the output stream. It does this as if it first converts thisdouble 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. The bytes written by this method may be read by the readDouble method of interface DataInput, which will then return a double equal to v.

Specified by:

[writeDouble](../../../java/io/DataOutput.html#writeDouble%28double%29) in interface [DataOutput](../../../java/io/DataOutput.html "interface in java.io")

Specified by:

[writeDouble](../../../javax/imageio/stream/ImageOutputStream.html#writeDouble%28double%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

v - the double value to be written.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeBytes

public void writeBytes(String s) throws IOException

Description copied from interface: [DataOutput](../../../java/io/DataOutput.html#writeBytes%28java.lang.String%29)

Writes a string to the output stream. For every character in the strings, taken in order, one byte is written to the output stream. Ifs 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.

Specified by:

[writeBytes](../../../java/io/DataOutput.html#writeBytes%28java.lang.String%29) in interface [DataOutput](../../../java/io/DataOutput.html "interface in java.io")

Specified by:

[writeBytes](../../../javax/imageio/stream/ImageOutputStream.html#writeBytes%28java.lang.String%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

s - the string of bytes to be written.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeChars

public void writeChars(String s) throws IOException

Description copied from interface: [DataOutput](../../../java/io/DataOutput.html#writeChars%28java.lang.String%29)

Writes every character in the string s, to the output stream, in order, two bytes per character. If s is null, a NullPointerException is thrown. If s.length is zero, then no characters are written. Otherwise, the character s[0] is written first, then s[1], and so on; the last character written iss[s.length-1]. For each character, two bytes are actually written, high-order byte first, in exactly the manner of thewriteChar method.

Specified by:

[writeChars](../../../java/io/DataOutput.html#writeChars%28java.lang.String%29) in interface [DataOutput](../../../java/io/DataOutput.html "interface in java.io")

Specified by:

[writeChars](../../../javax/imageio/stream/ImageOutputStream.html#writeChars%28java.lang.String%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

s - the string value to be written.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeUTF

public void writeUTF(String s) throws IOException

Description copied from interface: [DataOutput](../../../java/io/DataOutput.html#writeUTF%28java.lang.String%29)

Writes two bytes of length information to the output stream, followed by themodified 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 characterc 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 than65535, 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 bytes written by this method may be read by the readUTF method of interfaceDataInput , which will then return a String equal to s.

Specified by:

[writeUTF](../../../java/io/DataOutput.html#writeUTF%28java.lang.String%29) in interface [DataOutput](../../../java/io/DataOutput.html "interface in java.io")

Specified by:

[writeUTF](../../../javax/imageio/stream/ImageOutputStream.html#writeUTF%28java.lang.String%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

s - the string value to be written.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeShorts

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

Description copied from interface: [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html#writeShorts%28short[], int, int%29)

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 shorts[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:

[writeShorts](../../../javax/imageio/stream/ImageOutputStream.html#writeShorts%28short[], int, int%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

s - an array of shorts to be written.

off - the start offset in the data.

len - the number of shorts to write.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeChars

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

Description copied from interface: [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html#writeChars%28char[], int, int%29)

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 charc[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:

[writeChars](../../../javax/imageio/stream/ImageOutputStream.html#writeChars%28char[], int, int%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

c - an array of chars to be written.

off - the start offset in the data.

len - the number of chars to write.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeInts

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

Description copied from interface: [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html#writeInts%28int[], int, int%29)

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 inti[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:

[writeInts](../../../javax/imageio/stream/ImageOutputStream.html#writeInts%28int[], int, int%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

i - an array of ints to be written.

off - the start offset in the data.

len - the number of ints to write.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeLongs

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

Description copied from interface: [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html#writeLongs%28long[], int, int%29)

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 longl[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:

[writeLongs](../../../javax/imageio/stream/ImageOutputStream.html#writeLongs%28long[], int, int%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

l - an array of longs to be written.

off - the start offset in the data.

len - the number of longs to write.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeFloats

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

Description copied from interface: [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html#writeFloats%28float[], int, int%29)

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 floatf[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:

[writeFloats](../../../javax/imageio/stream/ImageOutputStream.html#writeFloats%28float[], int, int%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

f - an array of floats to be written.

off - the start offset in the data.

len - the number of floats to write.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeDoubles

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

Description copied from interface: [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html#writeDoubles%28double[], int, int%29)

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 doubled[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:

[writeDoubles](../../../javax/imageio/stream/ImageOutputStream.html#writeDoubles%28double[], int, int%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

d - an array of doubless to be written.

off - the start offset in the data.

len - the number of doubles to write.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeBit

public void writeBit(int bit) throws IOException

Description copied from interface: [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html#writeBit%28int%29)

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.

Specified by:

[writeBit](../../../javax/imageio/stream/ImageOutputStream.html#writeBit%28int%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

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

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

writeBits

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

Description copied from interface: [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html#writeBits%28long, int%29)

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, untilflushBefore 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:

[writeBits](../../../javax/imageio/stream/ImageOutputStream.html#writeBits%28long, int%29) in interface [ImageOutputStream](../../../javax/imageio/stream/ImageOutputStream.html "interface in javax.imageio.stream")

Parameters:

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.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

flushBits

protected final void flushBits() throws IOException

If the bit offset is non-zero, forces the remaining bits in the current byte to 0 and advances the stream position by one. This method should be called by subclasses at the beginning of the write(int) and write(byte[], int, int) methods.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.