com.comphenix.protocol.wrappers

Class WrappedDataWatcher

java.lang.Object

com.comphenix.protocol.wrappers.AbstractWrapper

com.comphenix.protocol.wrappers.WrappedDataWatcher

All Implemented Interfaces:

java.lang.Iterable<WrappedWatchableObject>

public class WrappedDataWatcher
extends AbstractWrapper
implements java.lang.Iterable<WrappedWatchableObject>

Wraps a DataWatcher that is used to transmit arbitrary key-value pairs with a given entity.

Author:

Kristian

Field Summary

Fields inherited from class com.comphenix.protocol.wrappers.AbstractWrapper

handle, handleType

Constructor Summary

Constructors

Constructor and Description
WrappedDataWatcher() Initialize a new data watcher.
WrappedDataWatcher(java.util.List<WrappedWatchableObject> watchableObjects) Create a new data watcher for a list of watchable objects.
WrappedDataWatcher(java.lang.Object handle) Create a wrapper for a given data watcher.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.Integer,WrappedWatchableObject>	asMap() Retrieve a view of this DataWatcher as a map.
WrappedDataWatcher	deepClone() Clone the content of the current DataWatcher.
boolean	equals(java.lang.Object obj)
java.lang.Byte	getByte(int index) Get a watched byte.
WrappedChunkCoordinate	getChunkCoordinate(int index) Get a watched string.
org.bukkit.entity.Entity	getEntity() Retrieve the entity associated with this data watcher.
static WrappedDataWatcher	getEntityWatcher(org.bukkit.entity.Entity entity) Retrieve the data watcher associated with an entity.
java.lang.Float	getFloat(int index) Get a watched float.
java.lang.Integer	getInteger(int index) Get a watched integer.
org.bukkit.inventory.ItemStack	getItemStack(int index) Get a watched string.
java.lang.Object	getObject(int index) Retrieve a watchable object by index.
protected java.util.concurrent.locks.ReadWriteLock	getReadWriteLock() Retrieve the current read write lock.
java.lang.Short	getShort(int index) Get a watched short.
java.lang.String	getString(int index) Get a watched string.
static java.lang.Class<?>	getTypeClass(int id) Retrieve the type of a given ID, if it's allowed to be watched.
static java.lang.Integer	getTypeID(java.lang.Class<?> clazz) Retrieve the ID of a given type, if it's allowed to be watched.
protected java.util.Map<java.lang.Integer,java.lang.Object>	getWatchableObjectMap() Retrieve the underlying map of key values that stores watchable objects.
java.util.List<WrappedWatchableObject>	getWatchableObjects() Retrieve every watchable object in this watcher.
int	hashCode()
java.util.Set<java.lang.Integer>	indexSet() Retrieve a copy of every index associated with a watched object.
java.util.Iterator<WrappedWatchableObject>	iterator()
static WrappedDataWatcher	newWithEntity(org.bukkit.entity.Entity entity) Construct a new data watcher with the given entity.
WrappedWatchableObject	removeObject(int index) Remove a given object from the underlying DataWatcher.
void	setEntity(org.bukkit.entity.Entity entity) Set the entity associated with this data watcher.
void	setObject(int index, java.lang.Object newValue) Set a watched byte.
void	setObject(int index, java.lang.Object newValue, boolean update) Set a watched byte.
int	size() Retrieve the number of watched objects.
java.lang.String	toString()

Methods inherited from class com.comphenix.protocol.wrappers.AbstractWrapper

getHandle, getHandleType, setHandle

Methods inherited from class java.lang.Object

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

Constructor Detail

WrappedDataWatcher

public WrappedDataWatcher()

Initialize a new data watcher.

Throws:

FieldAccessException - If we're unable to wrap a DataWatcher.

WrappedDataWatcher

public WrappedDataWatcher(java.lang.Object handle)

Create a wrapper for a given data watcher.

Parameters:

handle - - the data watcher to wrap.

Throws:

FieldAccessException - If we're unable to wrap a DataWatcher.

WrappedDataWatcher

public WrappedDataWatcher(java.util.List<WrappedWatchableObject> watchableObjects)
                   throws FieldAccessException

Create a new data watcher for a list of watchable objects.

Note that the watchable objects are not cloned, and will be modified in place. Use "deepClone" if that is not desirable.

The removeObject(int) method will not modify the given list, however.

Parameters:

watchableObjects - - list of watchable objects that will be copied.

Throws:

FieldAccessException - Unable to read watchable objects.

Method Detail

newWithEntity

public static WrappedDataWatcher newWithEntity(org.bukkit.entity.Entity entity)

Construct a new data watcher with the given entity.

In 1.6.4 and ealier, this will fall back to using WrappedDataWatcher().

Parameters:

entity - - the entity.

Returns:

The wrapped data watcher.

getTypeID

public static java.lang.Integer getTypeID(java.lang.Class<?> clazz)
                                   throws FieldAccessException

Retrieve the ID of a given type, if it's allowed to be watched.

Returns:

The ID, or NULL if it cannot be watched.

Throws:

FieldAccessException - If we cannot initialize the reflection machinery.

getTypeClass

public static java.lang.Class<?> getTypeClass(int id)
                                       throws FieldAccessException

Retrieve the type of a given ID, if it's allowed to be watched.

Returns:

The type using a given ID, or NULL if it cannot be watched.

Throws:

FieldAccessException - If we cannot initialize the reflection machinery.

getByte

public java.lang.Byte getByte(int index)
                       throws FieldAccessException

Get a watched byte.

Parameters:

index - - index of the watched byte.

Returns:

The watched byte, or NULL if this value doesn't exist.

Throws:

FieldAccessException - Cannot read underlying field.

getShort

public java.lang.Short getShort(int index)
                         throws FieldAccessException

Get a watched short.

Parameters:

index - - index of the watched short.

Returns:

The watched short, or NULL if this value doesn't exist.

Throws:

FieldAccessException - Cannot read underlying field.

getInteger

public java.lang.Integer getInteger(int index)
                             throws FieldAccessException

Get a watched integer.

Parameters:

index - - index of the watched integer.

Returns:

The watched integer, or NULL if this value doesn't exist.

Throws:

FieldAccessException - Cannot read underlying field.

getFloat

public java.lang.Float getFloat(int index)
                         throws FieldAccessException

Get a watched float.

Parameters:

index - - index of the watched float.

Returns:

The watched float, or NULL if this value doesn't exist.

Throws:

FieldAccessException - Cannot read underlying field.

getString

public java.lang.String getString(int index)
                           throws FieldAccessException

Get a watched string.

Parameters:

index - - index of the watched string.

Returns:

The watched string, or NULL if this value doesn't exist.

Throws:

FieldAccessException - Cannot read underlying field.

getItemStack

public org.bukkit.inventory.ItemStack getItemStack(int index)
                                            throws FieldAccessException

Get a watched string.

Parameters:

index - - index of the watched string.

Returns:

The watched string, or NULL if this value doesn't exist.

Throws:

FieldAccessException - Cannot read underlying field.

getChunkCoordinate

public WrappedChunkCoordinate getChunkCoordinate(int index)
                                          throws FieldAccessException

Get a watched string.

Parameters:

index - - index of the watched string.

Returns:

The watched string, or NULL if this value doesn't exist.

Throws:

FieldAccessException - Cannot read underlying field.

getObject

public java.lang.Object getObject(int index)
                           throws FieldAccessException

Retrieve a watchable object by index.

Parameters:

index - - index of the object to retrieve.

Returns:

The watched object.

Throws:

FieldAccessException - Cannot read underlying field.

getWatchableObjects

public java.util.List<WrappedWatchableObject> getWatchableObjects()
                                                           throws FieldAccessException

Retrieve every watchable object in this watcher.

Returns:

Every watchable object.

Throws:

FieldAccessException - If reflection failed.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

indexSet

public java.util.Set<java.lang.Integer> indexSet()
                                          throws FieldAccessException

Retrieve a copy of every index associated with a watched object.

Returns:

Every watched object index.

Throws:

FieldAccessException - If we're unable to read the underlying object.

deepClone

public WrappedDataWatcher deepClone()

Clone the content of the current DataWatcher.

Returns:

A cloned data watcher.

size

public int size()
         throws FieldAccessException

Retrieve the number of watched objects.

Returns:

Watched object count.

Throws:

FieldAccessException - If we're unable to read the underlying object.

removeObject

public WrappedWatchableObject removeObject(int index)

Remove a given object from the underlying DataWatcher.

Parameters:

index - - index of the object to remove.

Returns:

The watchable object that was removed, or NULL If none could be found.

setObject

public void setObject(int index,
             java.lang.Object newValue)
               throws FieldAccessException

Set a watched byte.

Parameters:

index - - index of the watched byte.

newValue - - the new watched value.

Throws:

FieldAccessException - Cannot read underlying field.

setObject

public void setObject(int index,
             java.lang.Object newValue,
             boolean update)
               throws FieldAccessException

Set a watched byte.

Parameters:

index - - index of the watched byte.

newValue - - the new watched value.

update - - whether or not to refresh every listening clients.

Throws:

FieldAccessException - Cannot read underlying field.

getReadWriteLock

protected java.util.concurrent.locks.ReadWriteLock getReadWriteLock()
                                                             throws FieldAccessException

Retrieve the current read write lock.

Returns:

Current read write lock.

Throws:

FieldAccessException - If we're unable to read the underlying field.

getWatchableObjectMap

protected java.util.Map<java.lang.Integer,java.lang.Object> getWatchableObjectMap()
                                                                           throws FieldAccessException

Retrieve the underlying map of key values that stores watchable objects.

Returns:

A map of watchable objects.

Throws:

FieldAccessException - If we don't have permission to perform reflection.

getEntityWatcher

public static WrappedDataWatcher getEntityWatcher(org.bukkit.entity.Entity entity)
                                           throws FieldAccessException

Retrieve the data watcher associated with an entity.

Parameters:

entity - - the entity to read from.

Returns:

Associated data watcher.

Throws:

FieldAccessException - Reflection failed.

iterator

public java.util.Iterator<WrappedWatchableObject> iterator()

Specified by:

iterator in interface java.lang.Iterable<WrappedWatchableObject>

asMap

public java.util.Map<java.lang.Integer,WrappedWatchableObject> asMap()

Retrieve a view of this DataWatcher as a map.

Any changes to the map will be reflected in this DataWatcher, and vice versa.

Returns:

A view of the data watcher as a map.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getEntity

public org.bukkit.entity.Entity getEntity()

Retrieve the entity associated with this data watcher.

Warning: This is only supported on 1.7.2 and above.

Returns:

The entity, or NULL.

setEntity

public void setEntity(org.bukkit.entity.Entity entity)

Set the entity associated with this data watcher.

Warning: This is only supported on 1.7.2 and above.

Parameters:

entity - - the new entity.