Added in API level 1

ObjectOutput

interface ObjectOutput : AutoCloseable, DataOutput
ObjectOutputStream

An ObjectOutputStream writes primitive data types and graphs of Java objects to an OutputStream.

ObjectOutput extends the DataOutput interface to include writing of objects. DataOutput includes methods for output of primitive types, ObjectOutput extends that interface to include objects, arrays, and Strings.

Summary

Public methods
abstract Unit

Closes the stream.

abstract Unit

Flushes the stream.

abstract Unit

Writes an array of bytes.

abstract Unit
write(b: ByteArray!, off: Int, len: Int)

Writes a sub array of bytes.

abstract Unit
write(b: Int)

Writes a byte.

abstract Unit

Write an object to the underlying storage or stream.

Inherited functions
Unit writeBoolean(v: Boolean)

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.

Unit writeByte(v: Int)

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.

Unit writeBytes(s: String!)

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.

Unit writeChar(v: Int)

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:

<code>(byte)(0xff &amp; (v &gt;&gt; 8))
  (byte)(0xff &amp; v)
  </code>

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.

Unit writeChars(s: String!)

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.

Unit writeDouble(v: Double)

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.

Unit writeFloat(v: Float)

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.

Unit writeInt(v: Int)

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:

<code>(byte)(0xff &amp; (v &gt;&gt; 24))
  (byte)(0xff &amp; (v &gt;&gt; 16))
  (byte)(0xff &amp; (v &gt;&gt;  8))
  (byte)(0xff &amp; v)
  </code>

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.

Unit writeLong(v: Long)

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:

<code>(byte)(0xff &amp; (v &gt;&gt; 56))
  (byte)(0xff &amp; (v &gt;&gt; 48))
  (byte)(0xff &amp; (v &gt;&gt; 40))
  (byte)(0xff &amp; (v &gt;&gt; 32))
  (byte)(0xff &amp; (v &gt;&gt; 24))
  (byte)(0xff &amp; (v &gt;&gt; 16))
  (byte)(0xff &amp; (v &gt;&gt;  8))
  (byte)(0xff &amp; v)
  </code>

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.

Unit writeShort(v: Int)

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:

<code>(byte)(0xff &amp; (v &gt;&gt; 8))
  (byte)(0xff &amp; v)
  </code>

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.

Unit writeUTF(s: String!)

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:

<code>(byte)(0xc0 | (0x1f &amp; (c &gt;&gt; 6)))
  (byte)(0x80 | (0x3f &amp; c))
  </code>

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:

<code>(byte)(0xe0 | (0x0f &amp; (c &gt;&gt; 12)))
  (byte)(0x80 | (0x3f &amp; (c &gt;&gt;  6)))
  (byte)(0x80 | (0x3f &amp; c))
  </code>

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.

Public methods

close

Added in API level 1
abstract fun close(): Unit

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

Exceptions
java.lang.Exception if this resource cannot be closed
java.io.IOException If an I/O error has occurred.

flush

Added in API level 1
abstract fun flush(): Unit

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

Exceptions
java.io.IOException If an I/O error has occurred.

write

Added in API level 1
abstract fun write(b: ByteArray!): Unit

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

Parameters
b ByteArray!: the data to be written
Exceptions
java.io.IOException if an I/O error occurs.
java.io.IOException If an I/O error has occurred.

write

Added in API level 1
abstract fun write(
    b: ByteArray!,
    off: Int,
    len: Int
): Unit

Writes a sub array of bytes.

Parameters
b ByteArray!: the data to be written
off Int: the start offset in the data
len Int: the number of bytes that are written
Exceptions
java.io.IOException if an I/O error occurs.
java.io.IOException If an I/O error has occurred.

write

Added in API level 1
abstract fun write(b: Int): Unit

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

Parameters
b Int: the byte
Exceptions
java.io.IOException if an I/O error occurs.
java.io.IOException If an I/O error has occurred.

writeObject

Added in API level 1
abstract fun writeObject(obj: Any!): Unit

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

Parameters
obj Any!: the object to be written
Exceptions
java.io.IOException Any of the usual Input/Output related exceptions.