multiverse.server.objects
Class Bag

java.lang.Object
  multiverse.server.objects.NamedPropertyClass
      multiverse.server.objects.Entity
          multiverse.server.objects.Bag

All Implemented Interfaces:

java.io.Serializable

public class Bag
extends Entity

a bag used to hold objects, either items or other bags

See Also:

Serialized Form

Field Summary

Fields inherited from class multiverse.server.objects.Entity

log, staticLock, subObjectNamespacesInt, transientPropertyKeys, type

Fields inherited from class multiverse.server.objects.NamedPropertyClass

lock, name

Constructor Summary

Bag()

Bag(int numSlots)

Bag(java.lang.Long oid)

Method Summary

boolean	addItem(java.lang.Long oid) add item to next available slot
java.lang.Integer	findItem(java.lang.Long itemOid) returns the slotnumber where the item is located in this bag, or null if not found
java.lang.Long	getItem(int slotNum)
java.lang.Long[]	getItemsList()
int	getNumSlots()
ObjectType	getType() Entity object type.
boolean	putItem(int slotNum, java.lang.Long itemOid) places item into specified slot.
boolean	removeItem(java.lang.Long oid)
void	setItemsList(java.lang.Long[] items) java beans paradigm for saving into the databse
void	setNumSlots(int numSlots) should only be set once

Methods inherited from class multiverse.server.objects.Entity

equals, equals, getAllEntitiesByNamespace, getEntityByNamespace, getEntityCount, getLock, getNamespace, getOid, getPersistenceFlag, getProperty, getSubObjectNamespaces, getSubObjectNamespacesInt, getTransientDataRef, hashCode, isDeleted, registerEntityByNamespace, registerTransientPropertyKey, removeEntityByNamespace, removeEntityByNamespace, setDeleted, setNamespace, setOid, setPersistenceFlag, setProperty, setSubObjectNamespaces, setSubObjectNamespacesInt, setType, toBytes, toString, unregisterTransientPropertyKey

Methods inherited from class multiverse.server.objects.NamedPropertyClass

getBooleanProperty, getIntProperty, getName, getPropertyMap, getPropertyMapRef, getStringProperty, lock, modifyIntProperty, setName, setPropertyMap, setupTransient, unlock

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Bag

public Bag()

Bag

public Bag(java.lang.Long oid)

Bag

public Bag(int numSlots)

Method Detail

getType

public ObjectType getType()

Description copied from class: Entity

Entity object type.

Overrides:

getType in class Entity

Returns:

ObjectTypes.unknown if no object type has been set.

getNumSlots

public int getNumSlots()

setNumSlots

public void setNumSlots(int numSlots)

should only be set once

putItem

public boolean putItem(int slotNum,
                       java.lang.Long itemOid)

places item into specified slot. slotNum starts with 0 returns false if there already is an item

getItem

public java.lang.Long getItem(int slotNum)

addItem

public boolean addItem(java.lang.Long oid)

add item to next available slot

removeItem

public boolean removeItem(java.lang.Long oid)

setItemsList

public void setItemsList(java.lang.Long[] items)

java beans paradigm for saving into the databse

getItemsList

public java.lang.Long[] getItemsList()

findItem

public java.lang.Integer findItem(java.lang.Long itemOid)

returns the slotnumber where the item is located in this bag, or null if not found

Parameters:

itemOid - oid for the item you are looking for

Returns:

slotnumber or null if not found