atavism.server.messages

Class PropertyMessage

java.lang.Object

atavism.msgsys.Message

atavism.msgsys.SubjectMessage

atavism.server.messages.PropertyMessage

All Implemented Interfaces:

EventParser, IPropertyMessage, java.io.Serializable

Direct Known Subclasses:

AbilityStatusMessage, AgisInventoryClient.alterCurrencyMessage, AgisInventoryClient.checkCurrencyMessage, AgisInventoryClient.countGenericItemMessage, AgisInventoryClient.DoesInventoryHasSufficientSpaceMessage, AgisInventoryClient.equipItemMessage, AgisInventoryClient.EquippedItemUsedMessage, AgisInventoryClient.GenerateGroundLootMessage, AgisInventoryClient.generateItemMessage, AgisInventoryClient.generateLootEffectMessage, AgisInventoryClient.generateLootMessage, AgisInventoryClient.getGenericItemDataMessage, AgisInventoryClient.getLootListMessage, AgisInventoryClient.getSpecificItemDataMessage, AgisInventoryClient.ItemAcquiredStatusMessage, AgisInventoryClient.ItemEquipStatusMessage, AgisInventoryClient.itemPropertyMessage, AgisInventoryClient.lootAllMessage, AgisInventoryClient.lootItemMessage, AgisInventoryClient.moveBagMessage, AgisInventoryClient.placeBagMessage, AgisInventoryClient.purchaseItemMessage, AgisInventoryClient.removeBagMessage, AgisInventoryClient.removeGenericItemMessage, AgisInventoryClient.removeSpecificItemMessage, AgisInventoryClient.SendInventoryUpdateMessage, AgisInventoryClient.unequipItemMessage, AgisMobClient.addTargetToCheckMessage, AgisMobClient.categoryUpdatedMessage, AgisMobClient.getIslandsDataMessage, AgisMobClient.PetLevelUpMessage, AgisMobClient.removeTargetToCheckMessage, AgisMobClient.spawnArenaCreatureMessage, AgisMobClient.spawnPetMessage, AgisMobClient.tameBeastMessage, AgisMobClient.targetInReactionRangeMessage, AgisMobClient.updatePetStatsMessage, AgisWorldManagerClient.SetMovementStateMessage, AgisWorldManagerClient.WaterRegionTransitionMessage, ArenaClient.addArenaCreatureMessage, ArenaClient.arenaKillMessage, ArenaClient.despawnGatesMessage, ArenaClient.dotScoreMessage, ArenaClient.duelChallengeAcceptMessage, ArenaClient.duelChallengeDeclineMessage, ArenaClient.duelChallengeDisconnectMessage, ArenaClient.duelChallengeMessage, ArenaClient.duelChallengeRemoveMessage, ArenaClient.duelDefeatMessage, ArenaClient.duelDisconnectMessage, ArenaClient.duelRemoveMessage, ArenaClient.duelStartMessage, ArenaClient.getArenaStatsMessage, ArenaClient.removeEffectsMessage, ArenaClient.removePlayerMessage, ArenaClient.resourceNodeAssaultedMessage, ArenaClient.startArenaCheckMessage, ClassAbilityClient.GetPlayerSkillLevelMessage, ClassAbilityClient.LearnAbilityMessage, ClassAbilityClient.levelChangeMessage, ClassAbilityClient.skillAlterCurrentMessage, ClassAbilityClient.skillDecreasedMessage, ClassAbilityClient.skillGetMessage, ClassAbilityClient.skillIncreasedMessage, ClassAbilityClient.skillLevelChangeMessage, ClassAbilityClient.skillResetMessage, ClassAbilityClient.UnlearnAbilityMessage, CombatClient.abilityUsedMessage, CombatClient.applyEffectMessage, CombatClient.DelModifyStatsMessage, CombatClient.FactionUpdateMessage, CombatClient.GetPlayerStatValueMessage, CombatClient.removeEffectMessage, CombatClient.stopAutoAttackMessage, CombatClient.updateActionBarMessage, DataLoggerClient.CharacterCreatedMessage, DataLoggerClient.CharacterDeletedMessage, DataLoggerClient.DataLogMessage, DataLoggerClient.LogEventMessage, FactionClient.AlterReputationMessage, FactionClient.getAttitudeMessage, FactionClient.getStanceMessage, GroupClient.createGroupMessage, GuildClient.createGuildMessage, GuildClient.getGuildMerchantMessage, GuildClient.getGuildWarehouseMessage, GuildClient.guildCommandMessage, QuestClient.AbandonQuestMessage, VoxelClient.BuildingAoETargetsInAreaMessage, VoxelClient.BuildingDamageMessage, VoxelClient.GetBuildingIsAttackableMessage, VoxelClient.GetBuildingPositionMessage, VoxelClient.GetBuildingTemplateMessage, VoxelClient.GetChestStorageOidMessage, WorldManagerClient.ExtensionMessage

public class PropertyMessage
extends SubjectMessage
implements EventParser, IPropertyMessage

general property about an obj/mob this is usually a statistic or state change, such as health, strength. Targeted state, such as whether a quest is available should use TargetedPropertyMessage

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.locks.Lock	lock
static MessageType	MSG_TYPE_PROPERTY
protected java.util.Map<java.lang.String,java.io.Serializable>	propertyMap
protected java.util.Collection<java.lang.String>	removedProperties

Fields inherited from class atavism.msgsys.SubjectMessage

oid

Fields inherited from class atavism.msgsys.Message

flags, msgId, msgInstanceOid, msgType, remoteAgent

Constructor Summary

Constructors

Constructor and Description
PropertyMessage()
PropertyMessage(MessageType msgType)
PropertyMessage(MessageType msgType, OID objOid)
PropertyMessage(OID objOid)
PropertyMessage(OID objOid, OID notifyOid)

Method Summary

Modifier and Type	Method and Description
protected static int	addPropertyStringElement(java.lang.String key, java.io.Serializable val, java.util.List<java.lang.String> propStrings, java.lang.String version, int len)
boolean	containsKey(java.lang.String key) Return true of the message contains the key argument; false otherwise
static int	createFilteredPropertyString(java.util.List<java.lang.String> propStrings, java.util.Map<java.lang.String,java.io.Serializable> propertyMap, java.lang.String version, java.util.Set<java.lang.String> filteredProps)
static int	createPropertyString(java.util.List<java.lang.String> propStrings, java.util.Map<java.lang.String,java.io.Serializable> propertyMap, java.lang.String version) Input parameter propStrings must be an empty list.
void	fromBuffer(AOByteBuffer buf)
java.io.Serializable	get(java.lang.String key) Deprecated. Use getProperty(String key) instead
Namespace	getNamespace()
java.io.Serializable	getProperty(java.lang.String key) Return the value associated with a key.
java.util.Map<java.lang.String,java.io.Serializable>	getPropertyMapRef()
java.util.Collection<java.lang.String>	getRemovedPropertiesRef()
boolean	hasProperty(java.lang.String key)
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	removeProperty(java.lang.String key) Remove the value with the key.
void	setNamespace(Namespace namespace) namespace is used to break up the property namespace. a single object has multiple property namespaces. this breaks up the object so that different plugins can manage different namespaces. for example, the combat plugin is authoritative for the combatdata namespace. it knows that it can change these values without talking to any other plugins.
void	setProperty(java.lang.String key, java.io.Serializable val) Associate the value with the key.
void	setProperty(java.lang.String key, java.io.Serializable val, boolean clone) Associate the value with the key.
AOByteBuffer	toBuffer(java.lang.String version)
AOByteBuffer	toBuffer(java.lang.String version, java.util.Map<java.lang.String,java.io.Serializable> propMap, java.util.Collection<java.lang.String> removedSet, java.util.Set<java.lang.String> filteredProps)
AOByteBuffer	toBuffer(java.lang.String version, java.util.Set<java.lang.String> filteredProps)
java.lang.String	toString()
static java.util.Map<java.lang.String,java.io.Serializable>	unmarshallProperyMap(AOByteBuffer buffer)

Methods inherited from class atavism.msgsys.SubjectMessage

getSubject, setSubject

Methods inherited from class atavism.msgsys.Message

getEnqueueTime, getMsgId, getMsgInstanceOid, getMsgType, getSenderName, isRPC, setEnqueueTime, setEnqueueTime, setMsgInstanceOid, setMsgType, toBytes, toBytes, toBytes, ToString

Methods inherited from class java.lang.Object

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

Field Detail

lock

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

propertyMap

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

removedProperties

protected java.util.Collection<java.lang.String> removedProperties

MSG_TYPE_PROPERTY

public static MessageType MSG_TYPE_PROPERTY

Constructor Detail

PropertyMessage

public PropertyMessage()

PropertyMessage

public PropertyMessage(MessageType msgType)

PropertyMessage

public PropertyMessage(OID objOid)

PropertyMessage

public PropertyMessage(MessageType msgType,
                       OID objOid)

PropertyMessage

public PropertyMessage(OID objOid,
                       OID notifyOid)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class SubjectMessage

setNamespace

public void setNamespace(Namespace namespace)

namespace is used to break up the property namespace. a single object has multiple property namespaces. this breaks up the object so that different plugins can manage different namespaces. for example, the combat plugin is authoritative for the combatdata namespace. it knows that it can change these values without talking to any other plugins.

Parameters:

namespace - the namespace

getNamespace

public Namespace getNamespace()

put

@Deprecated
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.

Specified by:

setProperty in interface IPropertyMessage

Parameters:

key - A String key.

val - A Serializable value.

setProperty

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

Associate the value with the key.

Parameters:

key - A String key.

val - A Serializable value.

clone - - whether a deep clone of this object is added to the property map instead

removeProperty

public void removeProperty(java.lang.String key)

Remove the value with the key.

Specified by:

removeProperty in interface IPropertyMessage

Parameters:

key - A String key.

containsKey

public boolean containsKey(java.lang.String key)

Return true of the message contains the key argument; false otherwise

Parameters:

key - The key to look for

Returns:

True if the key is contained in the list of keys; false otherwise.

get

@Deprecated
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.

Specified by:

getProperty in interface IPropertyMessage

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()

hasProperty

public boolean hasProperty(java.lang.String key)

toBuffer

public AOByteBuffer toBuffer(java.lang.String version)

toBuffer

public AOByteBuffer toBuffer(java.lang.String version,
                             java.util.Set<java.lang.String> filteredProps)

toBuffer

public AOByteBuffer toBuffer(java.lang.String version,
                             java.util.Map<java.lang.String,java.io.Serializable> propMap,
                             java.util.Collection<java.lang.String> removedSet,
                             java.util.Set<java.lang.String> filteredProps)

fromBuffer

public void fromBuffer(AOByteBuffer buf)

parseBytes

public void parseBytes(AOByteBuffer buf)

Specified by:

parseBytes in interface EventParser

getPropertyMapRef

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

getRemovedPropertiesRef

public java.util.Collection<java.lang.String> getRemovedPropertiesRef()

createPropertyString

public static int createPropertyString(java.util.List<java.lang.String> propStrings,
                                       java.util.Map<java.lang.String,java.io.Serializable> propertyMap,
                                       java.lang.String version)

Input parameter propStrings must be an empty list. This method will fill it with the properties.

Parameters:

propStrings -

Returns:

int

createFilteredPropertyString

public static int createFilteredPropertyString(java.util.List<java.lang.String> propStrings,
                                               java.util.Map<java.lang.String,java.io.Serializable> propertyMap,
                                               java.lang.String version,
                                               java.util.Set<java.lang.String> filteredProps)

addPropertyStringElement

protected static int addPropertyStringElement(java.lang.String key,
                                              java.io.Serializable val,
                                              java.util.List<java.lang.String> propStrings,
                                              java.lang.String version,
                                              int len)

unmarshallProperyMap

public static java.util.Map<java.lang.String,java.io.Serializable> unmarshallProperyMap(AOByteBuffer buffer)