ptserver.data.handler

Interface TokenHandler<T extends Token>

Type Parameters:

T - Type of Token that the handler handles.

All Known Implementing Classes:

ArrayTokenHandler, AttributeChangeTokenHandler, BooleanTokenHandler, ByteArrayTokenHandler, CommunicationTokenHandler, ComplexMatrixTokenHandler, ComplexTokenHandler, DoubleMatrixTokenHandler, DoubleTokenHandler, FloatTokenHandler, IntMatrixTokenHandler, IntTokenHandler, LongMatrixTokenHandler, LongTokenHandler, PingPongTokenHandler, RecordTokenHandler, RemoteEventTokenHandler, ShortTokenHandler, StringTokenHandler, UnionTokenHandler, UnsignedByteTokenHandler

public interface TokenHandler<T extends Token>

Convert a token of a particular type to a byte stream and back.

Since:

Ptolemy II 10.0

Version:

$Id: TokenHandler.java 67784 2013-10-26 16:53:27Z cxh $

Author:

ahuseyno

Accepted Rating:

Red (ahuseyno)

Proposed Rating:

Red (ahuseyno)

Method Summary

Modifier and Type	Method and Description
void	convertToBytes(T token, java.io.DataOutputStream outputStream) Convert the token to a byte stream according to the handler's parsing algorithm and output it to the outputStream.
T	convertToToken(java.io.DataInputStream inputStream, java.lang.Class<? extends T> tokenType) Return a token of the specified type by reading from the inputStream and converting to the token according to the parsing algorithm defined in the handler.

Method Detail

convertToBytes

void convertToBytes(T token,
                    java.io.DataOutputStream outputStream)
             throws java.io.IOException,
                    IllegalActionException

Convert the token to a byte stream according to the handler's parsing algorithm and output it to the outputStream.

Parameters:

token - the token to be converted

outputStream - the outputStream holding stream of bytes

Throws:

java.io.IOException - if there is a problem with the outputStream

IllegalActionException - if there is the state becomes inconsistent

convertToToken

T convertToToken(java.io.DataInputStream inputStream,
                 java.lang.Class<? extends T> tokenType)
          throws java.io.IOException,
                 IllegalActionException

Return a token of the specified type by reading from the inputStream and converting to the token according to the parsing algorithm defined in the handler.

Parameters:

inputStream - The inputStream that contains serialized version of a token

tokenType - the type of token to be read.

Returns:

Token parsed from inputStream

Throws:

java.io.IOException - if there is a problem with the outputStream

IllegalActionException - if there is the state becomes inconsistent