org.dmd.util

Class DmcOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

java.io.DataOutputStream

org.dmd.util.DmcOutputStream

All Implemented Interfaces:

Closeable, DataOutput, Flushable, AutoCloseable, DmcOutputStreamIF

public class DmcOutputStream
extends DataOutputStream
implements DmcOutputStreamIF

The DmcOutputStream implements the DmcOutputStreamIF to allow Dark Matter Objects to be serialized to a DataOutputStream. Exactly what gets written to the output stream depends on the dataType of the attribute being written and on the mode in which the DmcOutputStream has been created.

The two modes are file mode and wire mode; this is controlled by how the DmcOutputStream is constructed.

Attributes of dataType TRANSIENT are never written to the stream.

Field Summary

Fields inherited from class java.io.DataOutputStream

written

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
DmcOutputStream(OutputStream os) Constructs a new DmcOutputStream in file mode.
DmcOutputStream(OutputStream os, boolean mode) Constructs a new DmcOutputStream in the mode specified.

Method Summary

Modifier and Type	Method and Description
boolean	isFile()
void	writeAttributeCount(int count)
void	writeAttributeID(DmcAttributeInfo ai)
void	writeBytes(byte[] v)
void	writeValueCount(int size)

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 org.dmd.dmc.DmcOutputStreamIF

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

Methods inherited from interface java.io.DataOutput

write

Constructor Detail

DmcOutputStream

public DmcOutputStream(OutputStream os)

Constructs a new DmcOutputStream in file mode. Only PERSISTENT attributes will be written to the stream.

Parameters:

os - the output stream.

DmcOutputStream

public DmcOutputStream(OutputStream os,
                       boolean mode)

Constructs a new DmcOutputStream in the mode specified. All attributes but TRANSIENT ones will be written to the stream.

Parameters:

os - The output stream.

mode - true if this is file mode and false if it's wire mode.

Method Detail

isFile

public boolean isFile()

Specified by:

isFile in interface DmcOutputStreamIF

Returns:

true if we're in file mode and false if we're in wire mode.

writeAttributeID

public void writeAttributeID(DmcAttributeInfo ai)
                      throws Exception

Specified by:

writeAttributeID in interface DmcOutputStreamIF

Throws:

Exception

writeAttributeCount

public void writeAttributeCount(int count)
                         throws Exception

Specified by:

writeAttributeCount in interface DmcOutputStreamIF

Throws:

Exception

writeValueCount

public void writeValueCount(int size)
                     throws Exception

Specified by:

writeValueCount in interface DmcOutputStreamIF

Throws:

Exception

writeBytes

public void writeBytes(byte[] v)
                throws Exception

Specified by:

writeBytes in interface DmcOutputStreamIF

Throws:

Exception