org.elkoserver.json

Interface Encodable

All Known Subinterfaces:

Position

All Known Implementing Classes:

AuthDesc, Avatar, Bag, BankWorker, BasicObject, Box, Cap, Cartesian, CartesianPosition, Census, Chat, Container, Context, ContextKeyCap, Counter, Currency, Definer, DeviceUserMod, Dictionary, Die, EchoMod, EchoWorker, Flashlight, GateController, GeoPosition, Ground, HabitatMod, Head, Image, Invisible, Item, Key, Knick_knack, LoadDesc, Magical, Massive, Mod, Note, NoteMaker, ObjectDesc, Openable, PrivateChat, PutDesc, QueryDesc, Region, RequestDesc, ResultDesc, Rock, ServiceDesc, Short_sign, Sign, StyleDesc, StyleOptions, Switch, Table, TalkOptions, TalkPrefs, Tree, UpdateDesc, UpdateResultDesc, User, Walkable, Wall, WorkerObject, ZMQSendTester

public interface Encodable

Implementing this interface enables an object's state to be output as a JSON object literal.

Method Summary

Methods

Modifier and Type	Method and Description
JSONLiteral	encode(EncodeControl control) Produce a JSONLiteral representing the encoded state of this object, suitable for transmission over a messaging medium or for writing to persistent storage.

Method Detail

encode

JSONLiteral encode(EncodeControl control)

Produce a JSONLiteral representing the encoded state of this object, suitable for transmission over a messaging medium or for writing to persistent storage.

Parameters:

control - Encode control determining what flavor of encoding should be done.

Returns:

a JSONLiteral representing the encoded state of this object.