Class ImageOutputStreamImpl
- All Implemented Interfaces:
Closeable,DataInput,DataOutput,AutoCloseable,ImageInputStream,ImageOutputStream
- Direct Known Subclasses:
FileCacheImageOutputStream,FileImageOutputStream,MemoryCacheImageOutputStream
ImageOutputStream interface.
This class is designed to reduce the number of methods that must
be implemented by subclasses.-
Field Summary
Fields declared in class javax.imageio.stream.ImageInputStreamImpl
bitOffset, byteOrder, flushedPos, streamPos -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected final voidIf the bit offset is non-zero, forces the remaining bits in the current byte to 0 and advances the stream position by one.voidwrite(byte[] b) Writes a sequence of bytes to the stream at the current position.voidwriteBit(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.voidwriteBits(long bits, int numBits) Writes a sequence of bits, given by thenumBitsleast significant bits of thebitsargument in left-to-right order, to the stream at the current bit offset within the current byte position.voidwriteBoolean(boolean v) Writes abooleanvalue to the stream.voidwriteByte(int v) Writes the 8 low-order bits ofvto the stream.voidwriteBytes(String s) Writes a string to the output stream.voidwriteChar(int v) This method is a synonym forwriteShort.voidwriteChars(char[] c, int off, int len) Writes a sequence of chars to the stream at the current position.voidwriteChars(String s) Writes a string to the output stream.voidwriteDouble(double v) Writes adoublevalue, which is comprised of four bytes, to the output stream.voidwriteDoubles(double[] d, int off, int len) Writes a sequence of doubles to the stream at the current position.voidwriteFloat(float v) Writes afloatvalue, which is comprised of four bytes, to the output stream.voidwriteFloats(float[] f, int off, int len) Writes a sequence of floats to the stream at the current position.voidwriteInt(int v) Writes the 32 bits ofvto the stream.voidwriteInts(int[] i, int off, int len) Writes a sequence of ints to the stream at the current position.voidwriteLong(long v) Writes the 64 bits ofvto the stream.voidwriteLongs(long[] l, int off, int len) Writes a sequence of longs to the stream at the current position.voidwriteShort(int v) Writes the 16 low-order bits ofvto the stream.voidwriteShorts(short[] s, int off, int len) Writes a sequence of shorts to the stream at the current position.voidWrites 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 strings.Methods declared in class javax.imageio.stream.ImageInputStreamImpl
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, skipBytesMethods declared in class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods declared in interface javax.imageio.stream.ImageInputStream
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, skipBytesMethods declared in interface javax.imageio.stream.ImageOutputStream
flushBefore, write, write
-
Constructor Details
-
ImageOutputStreamImpl
public ImageOutputStreamImpl()Constructs anImageOutputStreamImpl.
-
-
Method Details
-
write
Description copied from interface:ImageOutputStreamWrites a sequence of bytes to the stream at the current position. Ifb.lengthis 0, nothing is written. The byteb[0]is written first, then the byteb[1], and so on.If the bit offset within the stream is non-zero, the remainder of the current byte is padded with 0s and written out first. The bit offset will be 0 after the write.
- Specified by:
writein interfaceDataOutput- Specified by:
writein interfaceImageOutputStream- Parameters:
b- an array ofbytes to be written.- Throws:
IOException- if an I/O error occurs.
-
writeBoolean
Description copied from interface:ImageOutputStreamWrites abooleanvalue to the stream. Ifvis true, the value(byte)1is written; ifvis false, the value(byte)0is written.If the bit offset within the stream is non-zero, the remainder of the current byte is padded with 0s and written out first. The bit offset will be 0 after the write.
- Specified by:
writeBooleanin interfaceDataOutput- Specified by:
writeBooleanin interfaceImageOutputStream- Parameters:
v- thebooleanto be written.- Throws:
IOException- if an I/O error occurs.
-
writeByte
Description copied from interface:ImageOutputStreamWrites the 8 low-order bits ofvto the stream. The 24 high-order bits ofvare ignored. (This means thatwriteBytedoes exactly the same thing aswritefor an integer argument.)If the bit offset within the stream is non-zero, the remainder of the current byte is padded with 0s and written out first. The bit offset will be 0 after the write.
- Specified by:
writeBytein interfaceDataOutput- Specified by:
writeBytein interfaceImageOutputStream- Parameters:
v- anintcontaining the byte value to be written.- Throws:
IOException- if an I/O error occurs.
-
writeShort
Description copied from interface:ImageOutputStreamWrites the 16 low-order bits ofvto the stream. The 16 high-order bits ofvare ignored. If the stream uses network byte order, the bytes written, in order, will be:(byte)((v >> 8) & 0xff) (byte)(v & 0xff)
Otherwise, the bytes written will be:(byte)(v & 0xff) (byte)((v >> 8) & 0xff)
If the bit offset within the stream is non-zero, the remainder of the current byte is padded with 0s and written out first. The bit offset will be 0 after the write.
- Specified by:
writeShortin interfaceDataOutput- Specified by:
writeShortin interfaceImageOutputStream- Parameters:
v- anintcontaining the short value to be written.- Throws:
IOException- if an I/O error occurs.
-
writeChar
Description copied from interface:ImageOutputStreamThis method is a synonym forwriteShort.- Specified by:
writeCharin interfaceDataOutput- Specified by:
writeCharin interfaceImageOutputStream- Parameters:
v- anintcontaining the char (unsigned short) value to be written.- Throws:
IOException- if an I/O error occurs.- See Also:
-
writeInt
Description copied from interface:ImageOutputStreamWrites the 32 bits ofvto the stream. If the stream uses network byte order, the bytes written, in order, will be:(byte)((v >> 24) & 0xff) (byte)((v >> 16) & 0xff) (byte)((v >> 8) & 0xff) (byte)(v & 0xff)
Otherwise, the bytes written will be:(byte)(v & 0xff) (byte)((v >> 8) & 0xff) (byte)((v >> 16) & 0xff) (byte)((v >> 24) & 0xff)
If the bit offset within the stream is non-zero, the remainder of the current byte is padded with 0s and written out first. The bit offset will be 0 after the write.
- Specified by:
writeIntin interfaceDataOutput- Specified by:
writeIntin interfaceImageOutputStream- Parameters:
v- anintcontaining the value to be written.- Throws:
IOException- if an I/O error occurs.
-
writeLong
Description copied from interface:ImageOutputStreamWrites the 64 bits ofvto the stream. If the stream uses network byte order, the bytes written, in order, will be:(byte)((v >> 56) & 0xff) (byte)((v >> 48) & 0xff) (byte)((v >> 40) & 0xff) (byte)((v >> 32) & 0xff) (byte)((v >> 24) & 0xff) (byte)((v >> 16) & 0xff) (byte)((v >> 8) & 0xff) (byte)(v & 0xff)
Otherwise, the bytes written will be:(byte)(v & 0xff) (byte)((v >> 8) & 0xff) (byte)((v >> 16) & 0xff) (byte)((v >> 24) & 0xff) (byte)((v >> 32) & 0xff) (byte)((v >> 40) & 0xff) (byte)((v >> 48) & 0xff) (byte)((v >> 56) & 0xff)
If the bit offset within the stream is non-zero, the remainder of the current byte is padded with 0s and written out first. The bit offset will be 0 after the write.
- Specified by:
writeLongin interfaceDataOutput- Specified by:
writeLongin interfaceImageOutputStream- Parameters:
v- alongcontaining the value to be written.- Throws:
IOException- if an I/O error occurs.
-
writeFloat
Description copied from interface:ImageOutputStreamWrites afloatvalue, which is comprised of four bytes, to the output stream. It does this as if it first converts thisfloatvalue to anintin exactly the manner of theFloat.floatToIntBitsmethod and then writes the int value in exactly the manner of thewriteIntmethod.If the bit offset within the stream is non-zero, the remainder of the current byte is padded with 0s and written out first. The bit offset will be 0 after the write.
- Specified by:
writeFloatin interfaceDataOutput- Specified by:
writeFloatin interfaceImageOutputStream- Parameters:
v- afloatcontaining the value to be written.- Throws:
IOException- if an I/O error occurs.
-
writeDouble
Description copied from interface:ImageOutputStreamWrites adoublevalue, which is comprised of four bytes, to the output stream. It does this as if it first converts thisdoublevalue to alongin exactly the manner of theDouble.doubleToLongBitsmethod and then writes the long value in exactly the manner of thewriteLongmethod.If the bit offset within the stream is non-zero, the remainder of the current byte is padded with 0s and written out first. The bit offset will be 0 after the write.
- Specified by:
writeDoublein interfaceDataOutput- Specified by:
writeDoublein interfaceImageOutputStream- Parameters:
v- adoublecontaining the value to be written.- Throws:
IOException- if an I/O error occurs.
-
writeBytes
Description copied from interface:ImageOutputStreamWrites a string to the output stream. For every character in the strings, taken in order, one byte is written to the output stream. Ifsisnull, aNullPointerExceptionis thrown.If
s.lengthis zero, then no bytes are written. Otherwise, the characters[0]is written first, thens[1], and so on; the last character written iss[s.length-1]. For each character, one byte is written, the low-order byte, in exactly the manner of thewriteBytemethod. The high-order eight bits of each character in the string are ignored.If the bit offset within the stream is non-zero, the remainder of the current byte is padded with 0s and written out first. The bit offset will be 0 after the write.
- Specified by:
writeBytesin interfaceDataOutput- Specified by:
writeBytesin interfaceImageOutputStream- Parameters:
s- aStringcontaining the value to be written.- Throws:
IOException- if an I/O error occurs.
-
writeChars
Description copied from interface:ImageOutputStreamWrites a string to the output stream. For every character in the strings, 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. Ifsisnull, aNullPointerExceptionis thrown.If
s.lengthis zero, then no bytes are written. Otherwise, the characters[0]is written first, thens[1], and so on; the last character written iss[s.length-1].If the bit offset within the stream is non-zero, the remainder of the current byte is padded with 0s and written out first. The bit offset will be 0 after the write.
- Specified by:
writeCharsin interfaceDataOutput- Specified by:
writeCharsin interfaceImageOutputStream- Parameters:
s- aStringcontaining the value to be written.- Throws:
IOException- if an I/O error occurs.
-
writeUTF
Description copied from interface:ImageOutputStreamWrites 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 strings. Ifsisnull, aNullPointerExceptionis thrown. Each character in the stringsis converted to a group of one, two, or three bytes, depending on the value of the character.If a character
cis in the range\u0001through\u007f, it is represented by one byte:(byte)c
If a character
cis\u0000or is in the range\u0080through\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
cis in the range\u0800throughuffff, 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
sis calculated. If this number is larger than65535, then aUTFDataFormatExceptionis thrown. Otherwise, this length is written to the output stream in exactly the manner of thewriteShortmethod; after this, the one-, two-, or three-byte representation of each character in the stringsis written.The current byte order setting is ignored.
If the bit offset within the stream is non-zero, the remainder of the current byte is padded with 0s and written out first. The bit offset will be 0 after the write.
Note: This method should not be used in the implementation of image formats that use standard UTF-8, because the modified UTF-8 used here is incompatible with standard UTF-8.
- Specified by:
writeUTFin interfaceDataOutput- Specified by:
writeUTFin interfaceImageOutputStream- Parameters:
s- aStringcontaining the value to be written.- Throws:
UTFDataFormatException- if the modified UTF-8 representation ofsrequires more than 65536 bytes.IOException- if an I/O error occurs.
-
writeShorts
Description copied from interface:ImageOutputStreamWrites a sequence of shorts to the stream at the current position. Iflenis 0, nothing is written. The shorts[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:
writeShortsin interfaceImageOutputStream- Parameters:
s- an array ofshorts to be written.off- the start offset in the data.len- the number ofshorts to write.- Throws:
IOException- if an I/O error occurs.
-
writeChars
Description copied from interface:ImageOutputStreamWrites a sequence of chars to the stream at the current position. Iflenis 0, nothing is written. The charc[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:
writeCharsin interfaceImageOutputStream- Parameters:
c- an array ofchars to be written.off- the start offset in the data.len- the number ofchars to write.- Throws:
IOException- if an I/O error occurs.
-
writeInts
Description copied from interface:ImageOutputStreamWrites a sequence of ints to the stream at the current position. Iflenis 0, nothing is written. The inti[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:
writeIntsin interfaceImageOutputStream- Parameters:
i- an array ofints to be written.off- the start offset in the data.len- the number ofints to write.- Throws:
IOException- if an I/O error occurs.
-
writeLongs
Description copied from interface:ImageOutputStreamWrites a sequence of longs to the stream at the current position. Iflenis 0, nothing is written. The longl[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:
writeLongsin interfaceImageOutputStream- Parameters:
l- an array oflongs to be written.off- the start offset in the data.len- the number oflongs to write.- Throws:
IOException- if an I/O error occurs.
-
writeFloats
Description copied from interface:ImageOutputStreamWrites a sequence of floats to the stream at the current position. Iflenis 0, nothing is written. The floatf[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:
writeFloatsin interfaceImageOutputStream- Parameters:
f- an array offloats to be written.off- the start offset in the data.len- the number offloats to write.- Throws:
IOException- if an I/O error occurs.
-
writeDoubles
Description copied from interface:ImageOutputStreamWrites a sequence of doubles to the stream at the current position. Iflenis 0, nothing is written. The doubled[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:
writeDoublesin interfaceImageOutputStream- Parameters:
d- an array ofdoubless to be written.off- the start offset in the data.len- the number ofdoubles to write.- Throws:
IOException- if an I/O error occurs.
-
writeBit
Description copied from interface:ImageOutputStreamWrites 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:
writeBitin interfaceImageOutputStream- Parameters:
bit- anintwhose least significant bit is to be written to the stream.- Throws:
IOException- if an I/O error occurs.
-
writeBits
Description copied from interface:ImageOutputStreamWrites a sequence of bits, given by thenumBitsleast significant bits of thebitsargument in left-to-right order, to the stream at the current bit offset within the current byte position. The upper64 - numBitsbits of the argument are ignored. The bit offset is advanced bynumBitsand 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
flushBeforeis called. At that time, all bit data prior to the flushed position will be written.If any bits of a particular byte have never been set at the time the byte is flushed to the destination, those bits will be set to 0 automatically.
- Specified by:
writeBitsin interfaceImageOutputStream- Parameters:
bits- alongcontaining the bits to be written, starting with the bit in positionnumBits - 1down to the least significant bit.numBits- anintbetween 0 and 64, inclusive.- Throws:
IOException- if an I/O error occurs.
-
flushBits
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 thewrite(int)andwrite(byte[], int, int)methods.- Throws:
IOException- if an I/O error occurs.
-