equip.runtime
Class ObjectOutputStream

java.lang.Object
  java.io.OutputStream
      java.io.FilterOutputStream
          java.io.DataOutputStream
              equip.runtime.ObjectOutputStream

All Implemented Interfaces:

java.io.DataOutput

public class ObjectOutputStream

extends java.io.DataOutputStream

EQUIP-specific serialisation output stream for writing serialised instances of ValueBase to. Used in place of ObjectOutputStream since the serialisation is the same for EQUIP IDL-defined classes in C++ as well.

Field Summary

static short	MAGIC Internal constant - stream header magic number ('E','q')
(package private) static byte	TC_NULL Internal constant - code for a null value
(package private) static byte	TC_OBJECT Internal constant - code for an object
(package private) static byte	TC_STRING Internal constant - code for a string
static short	VERSION Internal constant - serialisation version

Fields inherited from class java.io.DataOutputStream

written

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

ObjectOutputStream(java.io.OutputStream out)
Construct over a OutputStream.

Method Summary

void	writeObject(ValueBase object) Write an object (subclass of ValueBase) to the output stream; will write a nulls if provided.
void	writeObjectEnd() Internal operation use by object serialisers
void	writeObjectStart() Internal operation use by object serialisers
void	writeString(java.lang.String s) Write a Java string; will send a null if provided

Methods inherited from class java.io.DataOutputStream

flush, size, write, write, writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeDouble, writeFloat, writeInt, writeLong, writeShort, writeUTF

Methods inherited from class java.io.FilterOutputStream

close, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.io.DataOutput

write

Field Detail

MAGIC

public static final short MAGIC

Internal constant - stream header magic number ('E','q')

See Also:

Constant Field Values

VERSION

public static final short VERSION

Internal constant - serialisation version

See Also:

Constant Field Values

TC_NULL

static final byte TC_NULL

Internal constant - code for a null value

See Also:

Constant Field Values

TC_OBJECT

static final byte TC_OBJECT

Internal constant - code for an object

See Also:

Constant Field Values

TC_STRING

static final byte TC_STRING

Internal constant - code for a string

See Also:

Constant Field Values

Constructor Detail

ObjectOutputStream

public ObjectOutputStream(java.io.OutputStream out)
                   throws java.io.IOException

Construct over a OutputStream. Note: like ObjectOutputStream, this constructor immediately write header information to the output stream and flush it; this information is required by the corresponding ObjectInputStream.

Throws:

java.io.IOException - Some internal problem (not likely).

Method Detail

writeString

public void writeString(java.lang.String s)
                 throws java.io.IOException

Write a Java string; will send a null if provided

Throws:

java.io.IOException

writeObject

public void writeObject(ValueBase object)
                 throws java.io.IOException

Write an object (subclass of ValueBase) to the output stream; will write a nulls if provided.

Throws:

java.io.IOException - Miscellaneous problem, e.g. end of stream.

writeObjectStart

public void writeObjectStart()
                      throws java.io.IOException

Internal operation use by object serialisers

Throws:

java.io.IOException

writeObjectEnd

public void writeObjectEnd()
                    throws java.io.IOException

Internal operation use by object serialisers

Throws:

java.io.IOException