Package com.comphenix.protocol.wrappers

Class LegacyDataWatcher

java.lang.Object

com.comphenix.protocol.wrappers.AbstractWrapper

com.comphenix.protocol.wrappers.LegacyDataWatcher

All Implemented Interfaces:

IDataWatcher, Iterable<WrappedWatchableObject>

public class LegacyDataWatcher
extends AbstractWrapper
implements IDataWatcher

Represents a DataWatcher

Field Summary

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

handle, handleType

Constructor Summary

Constructors

Constructor	Description
LegacyDataWatcher()	Deprecated.
LegacyDataWatcher(Object handle)	Constructs a new DataWatcher wrapper around a NMS handle.
LegacyDataWatcher(List<WrappedWatchableObject> objects)	Deprecated.
LegacyDataWatcher(org.bukkit.entity.Entity entity)	Deprecated.

Method Summary

Modifier and Type	Method	Description
Map<Integer,WrappedWatchableObject>	asMap()	Deprecated.
void	clear()	Deprecated.
IDataWatcher	deepClone()	Clone the content of the current DataWatcher.
boolean	equals(Object obj)
org.bukkit.entity.Entity	getEntity()	Retrieve the entity associated with this data watcher.
Set<Integer>	getIndexes()	Deprecated.
Object	getObject(int index)	Retrieve a watchable object by index.
Object	getObject(WrappedDataWatcher.WrappedDataWatcherObject object)	Retrieve a watchable object by watcher object.
WrappedWatchableObject	getWatchableObject(int index)	Gets the item at a given index.
List<WrappedWatchableObject>	getWatchableObjects()	Gets a list of the contents of this DataWatcher.
int	hashCode()
boolean	hasIndex(int index)	Whether or not this DataWatcher has an object at a given index.
Set<Integer>	indexSet()	Deprecated.
Iterator<WrappedWatchableObject>	iterator()
WrappedWatchableObject	remove(int index)	Removes the item at a given index.
WrappedWatchableObject	removeObject(int index)	Deprecated. Renamed to remove(int)
void	setEntity(org.bukkit.entity.Entity entity)	Set the entity associated with this data watcher.
void	setObject(WrappedDataWatcher.WrappedDataWatcherObject object, WrappedWatchableObject value, boolean update)
void	setObject(WrappedDataWatcher.WrappedDataWatcherObject object, Object value, boolean update)	Sets the DataWatcher Item associated with a given watcher object to a new value.
int	size()	Gets the size of this DataWatcher's contents.
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

Methods inherited from interface com.comphenix.protocol.wrappers.IDataWatcher

getHandle

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

LegacyDataWatcher

public LegacyDataWatcher(Object handle)

Constructs a new DataWatcher wrapper around a NMS handle. The resulting DataWatcher will likely have existing values that can be removed with clear().

Parameters:

handle - DataWatcher handle

LegacyDataWatcher

@Deprecated
public LegacyDataWatcher()

Deprecated.

Constructs a new DataWatcher using a fake egg entity. The resulting DataWatcher will not have any keys or values and new ones will have to be added using watcher objects.

LegacyDataWatcher

@Deprecated
public LegacyDataWatcher(org.bukkit.entity.Entity entity)

Deprecated.

Constructs a new DataWatcher using a real entity. The resulting DataWatcher will not have any keys or values and new ones will have to be added using watcher objects.

Parameters:

entity - The entity

LegacyDataWatcher

@Deprecated
public LegacyDataWatcher(List<WrappedWatchableObject> objects)

Deprecated.

Constructs a new DataWatcher using a fake egg entity and a given list of watchable objects.

Parameters:

objects - The list of objects

Method Details

asMap

@Deprecated
public Map<Integer,WrappedWatchableObject> asMap()

Deprecated.

Gets the contents of this DataWatcher as a map.

Specified by:

asMap in interface IDataWatcher

Returns:

The contents

getIndexes

@Deprecated
public Set<Integer> getIndexes()

Deprecated.

Gets a set containing the registered indexes.

Specified by:

getIndexes in interface IDataWatcher

Returns:

The set

getWatchableObjects

public List<WrappedWatchableObject> getWatchableObjects()

Gets a list of the contents of this DataWatcher.

Specified by:

getWatchableObjects in interface IDataWatcher

Returns:

The contents

iterator

public Iterator<WrappedWatchableObject> iterator()

Specified by:

iterator in interface Iterable<WrappedWatchableObject>

size

public int size()

Gets the size of this DataWatcher's contents.

Specified by:

size in interface IDataWatcher

Returns:

The size

getWatchableObject

public WrappedWatchableObject getWatchableObject(int index)

Gets the item at a given index.

Specified by:

getWatchableObject in interface IDataWatcher

Parameters:

index - Index to get

Returns:

The watchable object, or null if none exists

removeObject

@Deprecated
public WrappedWatchableObject removeObject(int index)

Deprecated.

Renamed to remove(int)

remove

public WrappedWatchableObject remove(int index)

Removes the item at a given index.

Specified by:

remove in interface IDataWatcher

Parameters:

index - Index to remove

Returns:

The previous value, or null if none existed

hasIndex

public boolean hasIndex(int index)

Whether or not this DataWatcher has an object at a given index.

Specified by:

hasIndex in interface IDataWatcher

Parameters:

index - Index to check for

Returns:

True if it does, false if not

indexSet

@Deprecated
public Set<Integer> indexSet()

Deprecated.

Returns a set containing all the registered indexes

Returns:

The set

clear

@Deprecated
public void clear()

Deprecated.

Clears the contents of this DataWatcher. The watcher will be empty after this operation is called.

Specified by:

clear in interface IDataWatcher

getObject

public Object getObject(int index)

Retrieve a watchable object by index.

Specified by:

getObject in interface IDataWatcher

Parameters:

index - Index of the object to retrieve.

Returns:

The watched object or null if it doesn't exist.

getObject

public Object getObject(WrappedDataWatcher.WrappedDataWatcherObject object)

Retrieve a watchable object by watcher object.

Specified by:

getObject in interface IDataWatcher

Parameters:

object - The watcher object

Returns:

The watched object or null if it doesn't exist.

setObject

public void setObject(WrappedDataWatcher.WrappedDataWatcherObject object,
 WrappedWatchableObject value,
 boolean update)

Specified by:

setObject in interface IDataWatcher

Parameters:

object -

value -

update -

setObject

public void setObject(WrappedDataWatcher.WrappedDataWatcherObject object,
 Object value,
 boolean update)

Sets the DataWatcher Item associated with a given watcher object to a new value. If there is not already an object at this index, the specified watcher object must have a serializer.

Specified by:

setObject in interface IDataWatcher

Parameters:

object - Associated watcher object

value - New value

Throws:

IllegalArgumentException - If the watcher object is null or must have a serializer and does not have one.

deepClone

public IDataWatcher deepClone()

Clone the content of the current DataWatcher.

Specified by:

deepClone in interface IDataWatcher

Returns:

A cloned data watcher.

getEntity

public org.bukkit.entity.Entity getEntity()

Retrieve the entity associated with this data watcher.

Specified by:

getEntity in interface IDataWatcher

Returns:

The entity, or NULL.

setEntity

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

Set the entity associated with this data watcher.

Specified by:

setEntity in interface IDataWatcher

Parameters:

entity - - the new entity.

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractWrapper

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractWrapper

toString

public String toString()

Overrides:

toString in class AbstractWrapper