org.jogre.common.comm
Interface ITransmittable

All Known Subinterfaces:
ITransmittableWithProps
All Known Implementing Classes:
CommBaseMessage, CommTableAction, GameSnapshot, JogreModel, Player, PlayerList, Table, TableList, User, UserList

public interface ITransmittable

Transmittable interface for all communication in the system. Any class whose values can be transmitted (and reconstructed again) should implement this class, create a flatten method and a constructor which builds the object again. NOTE: Each XML ITransmittable objects should always set a "layer" attribute to 0, 1 or 2 (base, game or table respectively).

Version:
Alpha 0.2.1
Author:
Bob Marks

Method Summary
 XMLElement flatten()
          This method flattens an ITransmittable object into a XMLElement which can be transmitted.
 

Method Detail

flatten

public XMLElement flatten()
This method flattens an ITransmittable object into a XMLElement which can be transmitted. The object can then be recreated again using a single XMLElement parameter constructor.

Returns:
XML version of the state of an object which can be constructed again.