net.sf.jrtps

Interface Marshaller<T>

Type Parameters:

T - Type of this Marshaller. Type is used to enforce symmetry between unmarshall and marshall methods.

All Known Implementing Classes:

ParticipantDataMarshaller, ParticipantMessageMarshaller, ParticipantStatelessMessageMarshaller, PublicationDataMarshaller, SubscriptionDataMarshaller, TopicDataMarshaller

public interface Marshaller<T>

Marshaller is used to transform Object to/from different data encodings.

Author:

mcr70

Method Summary

Modifier and Type	Method and Description
byte[]	extractKey(T data) Extracts a key from given object.
boolean	hasKey() Determines whether or not a key is associated with type T.
DataEncapsulation	marshall(T data) Marshalls given Object to DataEncapsulation
T	unmarshall(DataEncapsulation dEnc) Unmarshalls given DataEncapsulation to Object.

Method Detail

hasKey

boolean hasKey()

Determines whether or not a key is associated with type T.

Returns:

true if a key is associated with type T

extractKey

byte[] extractKey(T data)

Extracts a key from given object. If null is returned, it is assumed to be the same as a byte array of length 0. Returned byte array can be of any length. However, if the byte arrays length is greater than 15, it is internally converted to a MD5 hash.

Parameters:

data - Object that holds key

Returns:

key

unmarshall

T unmarshall(DataEncapsulation dEnc)
      throws IOException

Unmarshalls given DataEncapsulation to Object.

Parameters:

dEnc - DataEncapsulation

Returns:

An instance of type T

Throws:

IOException - if a failure is detected during operation

marshall

DataEncapsulation marshall(T data)
                    throws IOException

Marshalls given Object to DataEncapsulation

Parameters:

data - An Object to marshall

Returns:

DataEncapsulation

Throws:

IOException - if a failure is detected during operation