Netty/Buffer 4.1.107.Final · io.netty.buffer.ByteBufOutputStream

Modifier and Type	Field and Description
private final ByteBuf	buffer
private boolean	closed
private final int	startIndex
private DataOutputStream	utf8out

Access	Constructor and Description
public	ByteBufOutputStream(ByteBuf buffer) Creates a new stream which writes data to the specified `buffer`.

Method Summary

Modifier and Type	Method and Description
public ByteBuf	buffer() Returns the buffer where this stream is writing data.
public void	close() Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.
public void	write(byte[] the data. b, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.OutputStream.write. Implements java.io.DataOutput.write. Writes `len` bytes from array `b`, in order, to the output stream.
public void	write(byte[] the data. b) Overrides java.io.OutputStream.write. Implements java.io.DataOutput.write. Writes to the output stream all the bytes in array `b`.
public void	write(int the byte to be written. b) Implements abstract java.io.OutputStream.write. Implements java.io.DataOutput.write. Writes to the output stream the eight low-order bits of the argument `b`.
public void	writeBoolean(boolean the boolean to be written. v) Implements java.io.DataOutput.writeBoolean. Writes a `boolean` value to this output stream.
public void	writeByte(int the byte value to be written. v) Implements java.io.DataOutput.writeByte. Writes to the output stream the eight low-order bits of the argument `v`.
public void	writeBytes(String the string of bytes to be written. s) Implements java.io.DataOutput.writeBytes. Writes a string to the output stream.
public void	writeChar(int the `char` value to be written. v) Implements java.io.DataOutput.writeChar. Writes a `char` value, which is comprised of two bytes, to the output stream.
public void	writeChars(String the string value to be written. s) Implements java.io.DataOutput.writeChars. Writes every character in the string `s`, to the output stream, in order, two bytes per character.
public void	writeDouble(double the `double` value to be written. v) Implements java.io.DataOutput.writeDouble. Writes a `double` value, which is comprised of eight bytes, to the output stream.
public void	writeFloat(float the `float` value to be written. v) Implements java.io.DataOutput.writeFloat. Writes a `float` value, which is comprised of four bytes, to the output stream.
public void	writeInt(int the `int` value to be written. v) Implements java.io.DataOutput.writeInt. Writes an `int` value, which is comprised of four bytes, to the output stream.
public void	writeLong(long the `long` value to be written. v) Implements java.io.DataOutput.writeLong. Writes a `long` value, which is comprised of eight bytes, to the output stream.
public void	writeShort(int the `short` value to be written. v) Implements java.io.DataOutput.writeShort. Writes two bytes to the output stream to represent the value of the argument.
public void	writeUTF(String the string value to be written. s) Implements java.io.DataOutput.writeUTF. Writes two bytes of length information to the output stream, followed by the modified UTF-8 representation of every character in the string `s`.
public int	writtenBytes() Returns the number of written bytes by this stream so far.

Inherited from java.io.OutputStream:: flush nullOutputStream

buffer	back to summary
private final ByteBuf buffer

closed	back to summary
private boolean closed

startIndex	back to summary
private final int startIndex

utf8out	back to summary
private DataOutputStream utf8out

ByteBufOutputStream	back to summary
public ByteBufOutputStream(ByteBuf buffer) Creates a new stream which writes data to the specified `buffer`.

Method Detail

buffer	back to summary
public ByteBuf buffer() Returns the buffer where this stream is writing data.

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Doc from java.io.OutputStream.close. Closes this output stream and releases any system resources associated with this stream. The general contract of `close` is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(byte[] b, int off, int len) throws IOException Overrides java.io.OutputStream.write. Implements java.io.DataOutput.write. Doc from java.io.DataOutput.write. Writes `len` bytes from array `b`, 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 array `b`, 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]`. Parameters b:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Annotations @Override Exceptions IOException: if an I/O error occurs.

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

Overrides java.io.OutputStream.write.

Implements java.io.DataOutput.write.

Doc from java.io.DataOutput.write.

Writes len bytes from array b, 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 array b, 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].

Parameters

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

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(byte[] b) throws IOException Overrides java.io.OutputStream.write. Implements java.io.DataOutput.write. Doc from java.io.DataOutput.write. 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 byte `b[0]` is written first, then `b[1]`, and so on; the last byte written is `b[b.length-1]`. Parameters b:byte[] the data. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void write(byte[] b) throws IOException

Overrides java.io.OutputStream.write.

Implements java.io.DataOutput.write.

Doc from java.io.DataOutput.write.

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 byte b[0] is written first, then b[1], and so on; the last byte written is b[b.length-1].

Parameters

b:byte[]: the data.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(int b) throws IOException Implements abstract java.io.OutputStream.write. Implements java.io.DataOutput.write. Doc from java.io.DataOutput.write. Writes to the output stream the eight low-order bits of the argument `b`. The 24 high-order bits of `b` are ignored. Parameters b:int the byte to be written. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Implements java.io.DataOutput.write.

Doc from java.io.DataOutput.write.

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

Parameters

b:int: the byte to be written.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

writeBoolean back to summary

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

public void writeBoolean(boolean v) throws IOException

Implements java.io.DataOutput.writeBoolean.

Doc from java.io.DataOutput.writeBoolean.

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.

Parameters

v:boolean: the boolean to be written.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

writeByte back to summary

writeByte	back to summary
public void writeByte(int v) throws IOException Implements java.io.DataOutput.writeByte. Doc from java.io.DataOutput.writeByte. 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`. Parameters v:int the byte value to be written. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void writeByte(int v) throws IOException

Implements java.io.DataOutput.writeByte.

Doc from java.io.DataOutput.writeByte.

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.

Parameters

v:int: the byte value to be written.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

writeBytes back to summary

writeBytes	back to summary
public void writeBytes(String s) throws IOException Implements java.io.DataOutput.writeBytes. Doc from 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. Parameters s:String the string of bytes to be written. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void writeBytes(String s) throws IOException

Implements java.io.DataOutput.writeBytes.

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

Parameters

s:String: the string of bytes to be written.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

writeChar back to summary

writeChar	back to summary
public void writeChar(int v) throws IOException Implements java.io.DataOutput.writeChar. Doc from java.io.DataOutput.writeChar. 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`. Parameters v:int the `char` value to be written. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void writeChar(int v) throws IOException

Implements java.io.DataOutput.writeChar.

Doc from java.io.DataOutput.writeChar.

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.

Parameters

v:int: the char value to be written.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

writeChars back to summary

writeChars	back to summary
public void writeChars(String s) throws IOException Implements java.io.DataOutput.writeChars. Doc from java.io.DataOutput.writeChars. 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 is `s[s.length-1]`. For each character, two bytes are actually written, high-order byte first, in exactly the manner of the `writeChar` method. Parameters s:String the string value to be written. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void writeChars(String s) throws IOException

Implements java.io.DataOutput.writeChars.

Doc from java.io.DataOutput.writeChars.

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 is s[s.length-1]. For each character, two bytes are actually written, high-order byte first, in exactly the manner of the writeChar method.

Parameters

s:String: the string value to be written.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

writeDouble back to summary

writeDouble	back to summary
public void writeDouble(double v) throws IOException Implements java.io.DataOutput.writeDouble. Doc from java.io.DataOutput.writeDouble. Writes a `double` value, which is comprised of eight 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. 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`. Parameters v:double the `double` value to be written. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void writeDouble(double v) throws IOException

Implements java.io.DataOutput.writeDouble.

Doc from java.io.DataOutput.writeDouble.

Writes a double value, which is comprised of eight 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. 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.

Parameters

v:double: the double value to be written.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

writeFloat back to summary

writeFloat	back to summary
public void writeFloat(float v) throws IOException Implements java.io.DataOutput.writeFloat. Doc from 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. 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`. Parameters v:float the `float` value to be written. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void writeFloat(float v) throws IOException

Implements java.io.DataOutput.writeFloat.

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

Parameters

v:float: the float value to be written.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

writeInt back to summary

writeInt	back to summary
public void writeInt(int v) throws IOException Implements java.io.DataOutput.writeInt. Doc from java.io.DataOutput.writeInt. 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 interface `DataInput`, which will then return an `int` equal to `v`. Parameters v:int the `int` value to be written. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void writeInt(int v) throws IOException

Implements java.io.DataOutput.writeInt.

Doc from java.io.DataOutput.writeInt.

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 interface DataInput, which will then return an int equal to v.

Parameters

v:int: the int value to be written.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

writeLong back to summary

writeLong	back to summary
public void writeLong(long v) throws IOException Implements java.io.DataOutput.writeLong. Doc from java.io.DataOutput.writeLong. 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`. Parameters v:long the `long` value to be written. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void writeLong(long v) throws IOException

Implements java.io.DataOutput.writeLong.

Doc from java.io.DataOutput.writeLong.

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.

Parameters

v:long: the long value to be written.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

writeShort back to summary

writeShort	back to summary
public void writeShort(int v) throws IOException Implements java.io.DataOutput.writeShort. Doc from java.io.DataOutput.writeShort. 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`. Parameters v:int the `short` value to be written. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void writeShort(int v) throws IOException

Implements java.io.DataOutput.writeShort.

Doc from java.io.DataOutput.writeShort.

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.

Parameters

v:int: the short value to be written.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

writeUTF back to summary

writeUTF	back to summary
public void writeUTF(String s) throws IOException Implements java.io.DataOutput.writeUTF. Doc from java.io.DataOutput.writeUTF. Writes two bytes of length information to the output stream, 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 bytes written by this method may be read by the `readUTF` method of interface `DataInput`, which will then return a `String` equal to `s`. Parameters s:String the string value to be written. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void writeUTF(String s) throws IOException

Implements java.io.DataOutput.writeUTF.

Doc from java.io.DataOutput.writeUTF.

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

Parameters

s:String: the string value to be written.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

writtenBytes	back to summary
public int writtenBytes() Returns the number of written bytes by this stream so far.

public Class ByteBufOutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail