org.elkoserver.server.context.test

Class Counter

java.lang.Object

org.elkoserver.server.context.Mod

org.elkoserver.server.context.test.Counter

All Implemented Interfaces:

Cloneable, DispatchTarget, Encodable, ContextMod, GeneralMod, ItemMod, UserMod

public class Counter
extends Mod
implements GeneralMod

Mod to enable an object to function as a simple counter, maintly for testing control over persistence.

Constructor Summary

Constructors

Constructor and Description
Counter(int count) JSON-driven constructor.

Method Summary

Methods

Modifier and Type	Method and Description
JSONLiteral	encode(EncodeControl control) Encode this mod for transmission or persistence.
void	inc(User from) Message handler for the 'inc' message.

Methods inherited from class org.elkoserver.server.context.Mod

attachTo, clone, context, ensureHolding, ensureInContext, ensureReachable, ensureSameContext, ensureSameUser, holder, isEphemeral, markAsChanged, markAsEphemeral, object

Methods inherited from class java.lang.Object

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

Constructor Detail

Counter

@JSONMethod(value="count")
public Counter(int count)

JSON-driven constructor.

Method Detail

encode

public JSONLiteral encode(EncodeControl control)

Encode this mod for transmission or persistence.

Specified by:

encode in interface Encodable

Parameters:

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

Returns:

a JSON literal representing this mod.

inc

@JSONMethod
public void inc(User from)
         throws MessageHandlerException

Message handler for the 'inc' message. This message requests the counter to increment. recv: { to:REF, op:"inc" }
send: { to:REF, op:"set", from:REF, count:int }

Parameters:

from - The user requesting the census.

Throws:

MessageHandlerException - if 'from' is not in the same context as this mod, or if this mod is attached to a user and 'from' is not that user.