Top Description Fields Constructors Methods
io.netty.handler.codec.serialization

public Class ObjectEncoderOutputStream

extends OutputStream
implements ObjectOutput
Class Inheritance
All Implemented Interfaces
java.io.ObjectOutput, java.lang.AutoCloseable, java.io.DataOutput
Annotations
@Deprecated
Imports
io.netty.buffer.ByteBuf, .ByteBufOutputStream, .Unpooled, io.netty.util.internal.ObjectUtil, java.io.DataOutputStream, .IOException, .ObjectOutput, .ObjectOutputStream, .OutputStream

Deprecated

This class has been deprecated with no replacement, because serialization can be a security liability

An ObjectOutput which is interoperable with ObjectDecoder and ObjectDecoderInputStream.

Security: serialization can be a security liability, and should not be used without defining a list of classes that are allowed to be desirialized. Such a list can be specified with the jdk.serialFilter system property, for instance. See the serialization filtering article for more information.

Field Summary

Modifier and TypeField and Description
private final int
estimatedLength

private final DataOutputStream
out

Constructor Summary

AccessConstructor and Description
public
ObjectEncoderOutputStream(OutputStream
the OutputStream where the serialized form will be written out
out)

Creates a new ObjectOutput with the estimated length of 512 bytes.

public
ObjectEncoderOutputStream(OutputStream
the OutputStream where the serialized form will be written out
out, int
the estimated byte length of the serialized form of an object. If the length of the serialized form exceeds this value, the internal buffer will be expanded automatically at the cost of memory bandwidth. If this value is too big, it will also waste memory bandwidth. To avoid unnecessary memory copy or allocation cost, please specify the properly estimated value.
estimatedLength)

Creates a new ObjectOutput.

Method Summary

Modifier and TypeMethod and Description
public void
close()

Overrides java.io.OutputStream.close.

Implements java.io.ObjectOutput.close, java.io.Closeable.close.

Closes the stream.
public void
flush()

Overrides java.io.OutputStream.flush.

Implements java.io.ObjectOutput.flush, java.io.Flushable.flush.

Flushes the stream.
public final int
size()

public void
write(int
the byte
b)

Implements abstract java.io.OutputStream.write.

Implements java.io.ObjectOutput.write.

Writes a byte.
public void
write(byte[]
the data to be written
b, int
the start offset in the data
off, int
the number of bytes that are written
len)

Overrides java.io.OutputStream.write.

Implements java.io.ObjectOutput.write.

Writes a sub array of bytes.
public void
write(byte[]
the data to be written
b)

Overrides java.io.OutputStream.write.

Implements java.io.ObjectOutput.write.

Writes an array of bytes.
public final void
writeBoolean(boolean
the boolean to be written.
v)

Implements java.io.DataOutput.writeBoolean.

Writes a boolean value to this output stream.
public final 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 final void
writeBytes(String
the string of bytes to be written.
s)

Implements java.io.DataOutput.writeBytes.

Writes a string to the output stream.
public final 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 final 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 final 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 final 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 final 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 final 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
writeObject(Object
the object to be written
obj)

Implements java.io.ObjectOutput.writeObject.

Write an object to the underlying storage or stream.
public final 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 final void
writeUTF(String
the string value to be written.
str)

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.
Inherited from java.io.OutputStream:
nullOutputStream

Field Detail

estimatedLengthback to summary
private final int estimatedLength
outback to summary
private final DataOutputStream out

Constructor Detail

ObjectEncoderOutputStreamback to summary
public ObjectEncoderOutputStream(OutputStream out)

Creates a new ObjectOutput with the estimated length of 512 bytes.

Parameters
out:OutputStream

the OutputStream where the serialized form will be written out

ObjectEncoderOutputStreamback to summary
public ObjectEncoderOutputStream(OutputStream out, int estimatedLength)

Creates a new ObjectOutput.

Parameters
out:OutputStream

the OutputStream where the serialized form will be written out

estimatedLength:int

the estimated byte length of the serialized form of an object. If the length of the serialized form exceeds this value, the internal buffer will be expanded automatically at the cost of memory bandwidth. If this value is too big, it will also waste memory bandwidth. To avoid unnecessary memory copy or allocation cost, please specify the properly estimated value.

Method Detail

closeback to summary
public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.ObjectOutput.close, java.io.Closeable.close.

Doc from java.io.ObjectOutput.close.

Closes the stream. This method must be called to release any resources associated with the stream.

Annotations
@Override
Exceptions
IOException:
If an I/O error has occurred.
flushback to summary
public void flush() throws IOException

Overrides java.io.OutputStream.flush.

Implements java.io.ObjectOutput.flush, java.io.Flushable.flush.

Doc from java.io.ObjectOutput.flush.

Flushes the stream. This will write any buffered output bytes.

Annotations
@Override
Exceptions
IOException:
If an I/O error has occurred.
sizeback to summary
public final int size()
writeback to summary
public void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Implements java.io.ObjectOutput.write.

Doc from java.io.ObjectOutput.write.

Writes a byte. This method will block until the byte is actually written.

Parameters
b:int

the byte

Annotations
@Override
Exceptions
IOException:
If an I/O error has occurred.
writeback to summary
public void write(byte[] b, int off, int len) throws IOException

Overrides java.io.OutputStream.write.

Implements java.io.ObjectOutput.write.

Doc from java.io.ObjectOutput.write.

Writes a sub array of bytes.

Parameters
b:byte[]

the data to be written

off:int

the start offset in the data

len:int

the number of bytes that are written

Annotations
@Override
Exceptions
IOException:
If an I/O error has occurred.
writeback to summary
public void write(byte[] b) throws IOException

Overrides java.io.OutputStream.write.

Implements java.io.ObjectOutput.write.

Doc from java.io.ObjectOutput.write.

Writes an array of bytes. This method will block until the bytes are actually written.

Parameters
b:byte[]

the data to be written

Annotations
@Override
Exceptions
IOException:
If an I/O error has occurred.
writeBooleanback to summary
public final 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.
writeByteback to summary
public final 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.
writeBytesback to summary
public final 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.
writeCharback to summary
public final 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.
writeCharsback to summary
public final 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.
writeDoubleback to summary
public final 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.
writeFloatback to summary
public final 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.
writeIntback to summary
public final 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.
writeLongback to summary
public final 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.
writeObjectback to summary
public void writeObject(Object obj) throws IOException

Implements java.io.ObjectOutput.writeObject.

Doc from java.io.ObjectOutput.writeObject.

Write an object to the underlying storage or stream. The class that implements this interface defines how the object is written.

Parameters
obj:Object

the object to be written

Annotations
@Override
Exceptions
IOException:
Any of the usual Input/Output related exceptions.
writeShortback to summary
public final 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.
writeUTFback to summary
public final void writeUTF(String str) 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
str:String

the string value to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.