atavism.agis.plugins
Class AnimationClient.InvokeEffectMessage

java.lang.Object
  atavism.msgsys.Message
      atavism.msgsys.SubjectMessage
          atavism.agis.plugins.AnimationClient.InvokeEffectMessage

All Implemented Interfaces:

EventParser, java.io.Serializable

Enclosing class:

AnimationClient

public static class AnimationClient.InvokeEffectMessage
extends SubjectMessage
implements EventParser

InvokeEffectMessage Tells the client to invoke a coordinated effect. The message oid is used by the server to determine who can perceive the effect, but is not sent to the client. The client only sees the oid for the effect instance.

See Also:

Serialized Form

Field Summary

protected java.lang.String	effectName
protected OID	effectOid
protected java.util.concurrent.locks.Lock	lock
protected java.util.Map<java.lang.String,java.io.Serializable>	propertyMap

Fields inherited from class atavism.msgsys.SubjectMessage

oid

Constructor Summary

AnimationClient.InvokeEffectMessage()

AnimationClient.InvokeEffectMessage(OID oid, java.lang.String effectName)

Method Summary

java.io.Serializable	get(java.lang.String key) Deprecated. Use getProperty(String key) instead
java.lang.String	getEffectName()
OID	getEffectOid()
java.io.Serializable	getProperty(java.lang.String key) Return the value associated with a key.
java.util.Map<java.lang.String,java.io.Serializable>	getPropertyMap()
java.util.Set<java.lang.String>	keySet()
void	parseBytes(AOByteBuffer buf)
void	put(java.lang.String key, java.io.Serializable val) Deprecated. Use setProperty(String key, Serializable val) instead
void	setEffectName(java.lang.String effectName)
void	setEffectOid(OID oid)
void	setProperty(java.lang.String key, java.io.Serializable val) Associate the value with the key.
AOByteBuffer	toBuffer(java.lang.String version)
java.lang.String	toString()

Methods inherited from class atavism.msgsys.SubjectMessage

getSubject, setSubject

Methods inherited from class atavism.msgsys.Message

getEnqueueTime, getMsgId, getMsgType, getSenderName, isRPC, setEnqueueTime, setEnqueueTime, setMsgType, toBytes

Methods inherited from class java.lang.Object

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

Field Detail

effectName

protected java.lang.String effectName

effectOid

protected OID effectOid

lock

protected transient java.util.concurrent.locks.Lock lock

propertyMap

protected java.util.Map<java.lang.String,java.io.Serializable> propertyMap

Constructor Detail

AnimationClient.InvokeEffectMessage

public AnimationClient.InvokeEffectMessage()

AnimationClient.InvokeEffectMessage

public AnimationClient.InvokeEffectMessage(OID oid,
                                           java.lang.String effectName)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class SubjectMessage

setEffectName

public void setEffectName(java.lang.String effectName)

getEffectName

public java.lang.String getEffectName()

setEffectOid

public void setEffectOid(OID oid)

getEffectOid

public OID getEffectOid()

put

public void put(java.lang.String key,
                java.io.Serializable val)

Deprecated. Use setProperty(String key, Serializable val) instead

Associate the value with the key.

setProperty

public void setProperty(java.lang.String key,
                        java.io.Serializable val)

Associate the value with the key.

Parameters:

key - A String key.

val - A Serializable value.

get

public java.io.Serializable get(java.lang.String key)

Deprecated. Use getProperty(String key) instead

Get the value associated with a key.

getProperty

public java.io.Serializable getProperty(java.lang.String key)

Return the value associated with a key.

Parameters:

key - A String key.

Returns:

The Serializable value associated with the key, or null if none exists.

keySet

public java.util.Set<java.lang.String> keySet()

getPropertyMap

public java.util.Map<java.lang.String,java.io.Serializable> getPropertyMap()

toBuffer

public AOByteBuffer toBuffer(java.lang.String version)

parseBytes

public void parseBytes(AOByteBuffer buf)

Specified by:

parseBytes in interface EventParser