net.sf.jrtps.Marshaller Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jrtps Show documentation

jRTPS - An implementation of RTPS protocol by OMG

There is a newer version: 1.5.1

package net.sf.jrtps;

import java.io.IOException;

import net.sf.jrtps.message.DataEncapsulation;

/**
 * Marshaller is used to transform Object to/from different data encodings.
 * 
 * @author mcr70
 * 
 * @param 
 *            Type of this Marshaller. Type is used to enforce symmetry between
 *            unmarshall and marshall methods.
 */
public interface Marshaller {
    /**
     * Determines whether or not a key is associated with type T.
     */
    public boolean hasKey();

    /**
     * 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. 
     * 
     * @param data
     * @return key
     */
    public byte[] extractKey(T data);

    /**
     * Unmarshalls given DataEncapsulation to Object.
     * 
     * @param dEnc
     * @return An instance of type T
     * @throws IOException
     */
    public T unmarshall(DataEncapsulation dEnc) throws IOException;

    /**
     * Marshalls given Object to DataEncapsulation
     * 
     * @param data
     * @return DataEncapsulation
     * @throws IOException
     */
    public DataEncapsulation marshall(T data) throws IOException;
}