ptserver.data

Class TokenParser

java.lang.Object

ptserver.data.TokenParser

public final class TokenParser
extends java.lang.Object

This class is a singleton and is a central point for converting a token from a byte stream and back.

When the instances is created, a mapping from Token to its TokenHandlers is loaded from ptserver.data.TokenHandlers.properties ResourceBundle. This class fill parse a token from an input stream by figuring out its token identifier (based on the position of the TokenHandler in the TokenHandlers.properties) and then selecting appropriate TokenHandler to do the parsing

Similarly, the token would be converted to a byte stream by selecting a TokenHandler mapped to its class and using it to do the conversion.

Since:

Ptolemy II 10.0

Version:

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

Author:

ahuseyno

Accepted Rating:

Red (ahuseyno)

Proposed Rating:

Red (ahuseyno)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TokenParser.HandlerData<T extends Token> Data structure that stores handler, token type, and position tuple.

Method Summary

Modifier and Type	Method and Description
<T extends Token> void	convertToBytes(T token, java.io.DataOutputStream outputStream) Convert the token to a byte stream by first finding its TokenHandler and writing its position to the stream (first 2 bytes) followed by the conversion produced TokenHandler.
<T extends Token> void	convertToBytes(T token, java.io.OutputStream outputStream) Convert the token to a byte stream by first finding its TokenHandler and writing its position to the stream (first 2 bytes) followed by the conversion produced TokenHandler.
<T extends Token> T	convertToToken(java.io.DataInputStream inputStream) Read and parse the inputStream in order to recreate the Token.
<T extends Token> T	convertToToken(java.io.InputStream inputStream) Read and parse the inputStream in order to recreate the Token.
java.util.ArrayList<TokenParser.HandlerData<?>>	getHandlerList() Get the list of token handlers.
static TokenParser	getInstance() Return singleton instance of the TokenParser.
void	setTokenHandlers(java.util.LinkedHashMap<java.lang.String,java.lang.String> tokenHandlerMap) Set the list of token handlers.

Methods inherited from class java.lang.Object

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

Method Detail

convertToBytes

public <T extends Token> void convertToBytes(T token,
                                             java.io.DataOutputStream outputStream)
                                      throws java.io.IOException,
                                             IllegalActionException

Convert the token to a byte stream by first finding its TokenHandler and writing its position to the stream (first 2 bytes) followed by the conversion produced TokenHandler.

Type Parameters:

T - Type of the target token

Parameters:

token - Token to be converted

outputStream - outputStream used for the resulting byte stream

Throws:

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

IllegalActionException - if the state becomes inconsistent

convertToBytes

public <T extends Token> void convertToBytes(T token,
                                             java.io.OutputStream outputStream)
                                      throws java.io.IOException,
                                             IllegalActionException

Convert the token to a byte stream by first finding its TokenHandler and writing its position to the stream (first 2 bytes) followed by the conversion produced TokenHandler.

Type Parameters:

T - Type of the target token

Parameters:

token - Token to be converted

outputStream - outputStream used for the resulting byte stream

Throws:

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

IllegalActionException - if the state becomes inconsistent

convertToToken

public <T extends Token> T convertToToken(java.io.DataInputStream inputStream)
                                   throws java.io.IOException,
                                          IllegalActionException

Read and parse the inputStream in order to recreate the Token.

Type Parameters:

T - Type of Token

Parameters:

inputStream - InputStream containing byteStream of the token data where first 2 bytes indicated the token type (defined as TokenHandlers position)

Returns:

Token read from the inputStream

Throws:

java.io.IOException - is thrown in case of a problem with the outputStream

IllegalActionException - is thrown if the state becomes inconsistent

convertToToken

public <T extends Token> T convertToToken(java.io.InputStream inputStream)
                                   throws java.io.IOException,
                                          IllegalActionException

Read and parse the inputStream in order to recreate the Token.

Type Parameters:

T - Type of Token

Parameters:

inputStream - InputStream containing byteStream of the token data where first 2 bytes indicated the token type (defined as TokenHandlers position)

Returns:

Token read from the inputStream

Throws:

java.io.IOException - is thrown in case of a problem with the outputStream

IllegalActionException - is thrown if the state becomes inconsistent

getHandlerList

public java.util.ArrayList<TokenParser.HandlerData<?>> getHandlerList()

Get the list of token handlers.

Returns:

The list of loaded token handlers.

getInstance

public static TokenParser getInstance()
                               throws IllegalActionException

Return singleton instance of the TokenParser. The TokenParser is singleton to simplify operations with it since there is no need to pass the instance around. Also instantiation of the instance is costly since it relies on reflection.

Returns:

instance of the TokenParser

Throws:

IllegalActionException - if there is a problem loading the mapping from TokenHandlers.properties file.

setTokenHandlers

public void setTokenHandlers(java.util.LinkedHashMap<java.lang.String,java.lang.String> tokenHandlerMap)
                      throws IllegalActionException

Set the list of token handlers.

Parameters:

tokenHandlerMap - The populated map of token handlers.

Throws:

IllegalActionException - If the token handler does not map to an existing class or reflection instantiation of the handler fails.