info.bioinfweb.commons.io.streammessage

Class Message<T extends java.lang.Enum<T>>

java.lang.Object

info.bioinfweb.commons.io.streammessage.Message<T>

public abstract class Message<T extends java.lang.Enum<T>>
extends java.lang.Object

Abstract base class for all messages send between the main and the VLCFrameGrab application.

Since:

2.0.0

Author:

Ben Stöver

Constructor Summary

Constructors

Constructor and Description
Message(T type, int version)

Method Summary

Modifier and Type	Method and Description
protected abstract void	doRead(java.io.DataInputStream stream, int version) Subclasses should implement this method to read the data this message object contains.
T	getType()
int	getVersion()
void	read(java.io.DataInputStream stream) Reads the message version and than calls doRead.
void	write(java.io.DataOutputStream stream) Writes the message type and version to the stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message(T type,
               int version)

Method Detail

getType

public T getType()

getVersion

public int getVersion()

write

public void write(java.io.DataOutputStream stream)
           throws java.io.IOException,
                  NewerMessageVersionException

Writes the message type and version to the stream. This method can be extended by subclasses.

Parameters:

stream -

Throws:

java.io.IOException

NewerMessageVersionException

read

public void read(java.io.DataInputStream stream)
          throws java.io.IOException,
                 NewerMessageVersionException

Reads the message version and than calls doRead. The message type id not read because it must be read before to decide which message object to create.

Parameters:

stream - the stream to read the data from

Throws:

java.io.IOException

NewerMessageVersionException - if a version newer than the version of this class is read

doRead

protected abstract void doRead(java.io.DataInputStream stream,
                               int version)
                        throws java.io.IOException

Subclasses should implement this method to read the data this message object contains. The message type and version have already been read before this method is called.

Parameters:

stream - the stream to read the data from

version - the version which was read (smaller or equal to the version of this class)

Throws:

java.io.IOException