com.comphenix.protocol.wrappers

Class WrappedWatchableObject

java.lang.Object

com.comphenix.protocol.wrappers.WrappedWatchableObject

public class WrappedWatchableObject
extends java.lang.Object

Represents a watchable object.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	handle
protected StructureModifier<java.lang.Object>	modifier

Constructor Summary

Constructors

Constructor and Description
WrappedWatchableObject(int index, java.lang.Object value) Construct a watchable object from an index and a given value.
WrappedWatchableObject(java.lang.Object handle) Wrap a given raw Minecraft watchable object.

Method Summary

Methods

Modifier and Type	Method and Description
WrappedWatchableObject	deepClone() Clone the current wrapped watchable object, along with any contained objects.
boolean	equals(java.lang.Object obj)
boolean	getDirtyState() Retrieve whether or not the value must be synchronized with the client.
java.lang.Object	getHandle() Retrieves the underlying watchable object.
int	getIndex() Retrieve the index of this watchable object.
java.lang.Class<?>	getType() Retrieve the correct super type of the current value.
int	getTypeID() Retrieve the type ID of a watchable object.
java.lang.Object	getValue() Read the value field.
int	hashCode()
void	setDirtyState(boolean dirty) Set whether or not the value must be synchronized with the client.
void	setIndex(int index) Set the the index of this watchable object.
void	setTypeID(int id) Set the type ID of a watchable object.
void	setValue(java.lang.Object newValue) Update the value field.
void	setValue(java.lang.Object newValue, boolean updateClient) Update the value field.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

handle

protected java.lang.Object handle

modifier

protected StructureModifier<java.lang.Object> modifier

Constructor Detail

WrappedWatchableObject

public WrappedWatchableObject(java.lang.Object handle)

Wrap a given raw Minecraft watchable object.

Parameters:

handle - - the raw watchable object to wrap.

WrappedWatchableObject

public WrappedWatchableObject(int index,
                      java.lang.Object value)

Construct a watchable object from an index and a given value.

Parameters:

index - - the index.

value - - non-null value of specific types.

Method Detail

getHandle

public java.lang.Object getHandle()

Retrieves the underlying watchable object.

Returns:

The underlying watchable object.

getType

public java.lang.Class<?> getType()
                           throws FieldAccessException

Retrieve the correct super type of the current value.

Returns:

Super type.

Throws:

FieldAccessException - Unable to read values.

getIndex

public int getIndex()
             throws FieldAccessException

Retrieve the index of this watchable object. This is used to identify a value.

Returns:

Object index.

Throws:

FieldAccessException - Reflection failed.

setIndex

public void setIndex(int index)
              throws FieldAccessException

Set the the index of this watchable object.

Parameters:

index - - the new object index.

Throws:

FieldAccessException - Reflection failed.

getTypeID

public int getTypeID()
              throws FieldAccessException

Retrieve the type ID of a watchable object.

Returns:

Type ID that identifies the type of the value.

Throws:

FieldAccessException - Reflection failed.

setTypeID

public void setTypeID(int id)
               throws FieldAccessException

Set the type ID of a watchable object.

Parameters:

id - - the new ID.

Throws:

FieldAccessException - Reflection failed.

setValue

public void setValue(java.lang.Object newValue)
              throws FieldAccessException

Update the value field.

Parameters:

newValue - - new value.

Throws:

FieldAccessException - Unable to use reflection.

setValue

public void setValue(java.lang.Object newValue,
            boolean updateClient)
              throws FieldAccessException

Update the value field.

Parameters:

newValue - - new value.

updateClient - - whether or not to update listening clients.

Throws:

FieldAccessException - Unable to use reflection.

getValue

public java.lang.Object getValue()
                          throws FieldAccessException

Read the value field.

Returns:

The watched value.

Throws:

FieldAccessException - Unable to use reflection.

setDirtyState

public void setDirtyState(boolean dirty)
                   throws FieldAccessException

Set whether or not the value must be synchronized with the client.

Parameters:

dirty - - TRUE if the value should be synchronized, FALSE otherwise.

Throws:

FieldAccessException - Unable to use reflection.

getDirtyState

public boolean getDirtyState()
                      throws FieldAccessException

Retrieve whether or not the value must be synchronized with the client.

Returns:

TRUE if the value should be synchronized, FALSE otherwise.

Throws:

FieldAccessException - Unable to use reflection.

deepClone

public WrappedWatchableObject deepClone()
                                 throws FieldAccessException

Clone the current wrapped watchable object, along with any contained objects.

Returns:

A deep clone of the current watchable object.

Throws:

FieldAccessException - If we're unable to use reflection.

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object