Upstream/ProtocolLib
1
0
Fork 0
mirror of https://github.com/dmulloy2/ProtocolLib.git synced 2024-12-12 04:17:29 +01:00
Code Issues Projects Releases Wiki Activity
9778ed6fc5
ProtocolLib/Javadoc/com/comphenix/protocol/wrappers/WrappedDataWatcher.html
Kristian S. Stangeland 599e3b8828 Updated JavaDoc for 1.9.0
2012-12-27 17:44:04 +01:00

813 lines
40 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_07) on Thu Dec 27 17:42:38 CET 2012 -->
<title>WrappedDataWatcher</title>
<meta name="date" content="2012-12-27">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="WrappedDataWatcher";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/WrappedDataWatcher.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html" title="class in com.comphenix.protocol.wrappers"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/comphenix/protocol/wrappers/WrappedWatchableObject.html" title="class in com.comphenix.protocol.wrappers"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/comphenix/protocol/wrappers/WrappedDataWatcher.html" target="_top">Frames</a></li>
<li><a href="WrappedDataWatcher.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.comphenix.protocol.wrappers</div>
<h2 title="Class WrappedDataWatcher" class="title">Class WrappedDataWatcher</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.comphenix.protocol.wrappers.WrappedDataWatcher</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Iterable&lt;<a href="../../../../com/comphenix/protocol/wrappers/WrappedWatchableObject.html" title="class in com.comphenix.protocol.wrappers">WrappedWatchableObject</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">WrappedDataWatcher</span>
extends java.lang.Object
implements java.lang.Iterable&lt;<a href="../../../../com/comphenix/protocol/wrappers/WrappedWatchableObject.html" title="class in com.comphenix.protocol.wrappers">WrappedWatchableObject</a>&gt;</pre>
<div class="block">Wraps a DataWatcher that is used to transmit arbitrary key-value pairs with a given entity.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Kristian</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#handle">handle</a></strong></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#WrappedDataWatcher()">WrappedDataWatcher</a></strong>()</code>
<div class="block">Initialize a new data watcher.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#WrappedDataWatcher(java.util.List)">WrappedDataWatcher</a></strong>(java.util.List&lt;<a href="../../../../com/comphenix/protocol/wrappers/WrappedWatchableObject.html" title="class in com.comphenix.protocol.wrappers">WrappedWatchableObject</a>&gt;&nbsp;watchableObjects)</code>
<div class="block">Create a new data watcher for a list of watchable objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#WrappedDataWatcher(java.lang.Object)">WrappedDataWatcher</a></strong>(java.lang.Object&nbsp;handle)</code>
<div class="block">Create a wrapper for a given data watcher.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html" title="class in com.comphenix.protocol.wrappers">WrappedDataWatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#deepClone()">deepClone</a></strong>()</code>
<div class="block">Clone the content of the current DataWatcher.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object&nbsp;obj)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Byte</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#getByte(int)">getByte</a></strong>(int&nbsp;index)</code>
<div class="block">Get a watched byte.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html" title="class in com.comphenix.protocol.wrappers">WrappedChunkCoordinate</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#getChunkCoordinate(int)">getChunkCoordinate</a></strong>(int&nbsp;index)</code>
<div class="block">Get a watched string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html" title="class in com.comphenix.protocol.wrappers">WrappedDataWatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#getEntityWatcher(org.bukkit.entity.Entity)">getEntityWatcher</a></strong>(org.bukkit.entity.Entity&nbsp;entity)</code>
<div class="block">Retrieve the data watcher associated with an entity.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Float</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#getFloat(int)">getFloat</a></strong>(int&nbsp;index)</code>
<div class="block">Get a watched float.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#getHandle()">getHandle</a></strong>()</code>
<div class="block">Retrieves the underlying data watcher.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Integer</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#getInteger(int)">getInteger</a></strong>(int&nbsp;index)</code>
<div class="block">Get a watched integer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.bukkit.inventory.ItemStack</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#getItemStack(int)">getItemStack</a></strong>(int&nbsp;index)</code>
<div class="block">Get a watched string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#getObject(int)">getObject</a></strong>(int&nbsp;index)</code>
<div class="block">Retrieve a watchable object by index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.concurrent.locks.ReadWriteLock</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#getReadWriteLock()">getReadWriteLock</a></strong>()</code>
<div class="block">Retrieve the current read write lock.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Short</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#getShort(int)">getShort</a></strong>(int&nbsp;index)</code>
<div class="block">Get a watched short.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#getString(int)">getString</a></strong>(int&nbsp;index)</code>
<div class="block">Get a watched string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.Class&lt;?&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#getTypeClass(int)">getTypeClass</a></strong>(int&nbsp;id)</code>
<div class="block">Retrieve the type of a given ID, if it's allowed to be watched.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.Integer</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#getTypeID(java.lang.Class)">getTypeID</a></strong>(java.lang.Class&lt;?&gt;&nbsp;clazz)</code>
<div class="block">Retrieve the ID of a given type, if it's allowed to be watched.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.Integer,java.lang.Object&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#getWatchableObjectMap()">getWatchableObjectMap</a></strong>()</code>
<div class="block">Retrieve the underlying map of key values that stores watchable objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../com/comphenix/protocol/wrappers/WrappedWatchableObject.html" title="class in com.comphenix.protocol.wrappers">WrappedWatchableObject</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#getWatchableObjects()">getWatchableObjects</a></strong>()</code>
<div class="block">Retrieve every watchable object in this watcher.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#hashCode()">hashCode</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.Integer&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#indexSet()">indexSet</a></strong>()</code>
<div class="block">Retrieve a copy of every index associated with a watched object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Iterator&lt;<a href="../../../../com/comphenix/protocol/wrappers/WrappedWatchableObject.html" title="class in com.comphenix.protocol.wrappers">WrappedWatchableObject</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#iterator()">iterator</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/comphenix/protocol/wrappers/WrappedWatchableObject.html" title="class in com.comphenix.protocol.wrappers">WrappedWatchableObject</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#removeObject(int)">removeObject</a></strong>(int&nbsp;index)</code>
<div class="block">Remove a given object from the underlying DataWatcher.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#setObject(int, java.lang.Object)">setObject</a></strong>(int&nbsp;index,
java.lang.Object&nbsp;newValue)</code>
<div class="block">Set a watched byte.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#setObject(int, java.lang.Object, boolean)">setObject</a></strong>(int&nbsp;index,
java.lang.Object&nbsp;newValue,
boolean&nbsp;update)</code>
<div class="block">Set a watched byte.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#size()">size</a></strong>()</code>
<div class="block">Retrieve the number of watched objects.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="handle">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>handle</h4>
<pre>protected&nbsp;java.lang.Object handle</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="WrappedDataWatcher()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WrappedDataWatcher</h4>
<pre>public&nbsp;WrappedDataWatcher()</pre>
<div class="block">Initialize a new data watcher.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - If we're unable to wrap a DataWatcher.</dd></dl>
</li>
</ul>
<a name="WrappedDataWatcher(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WrappedDataWatcher</h4>
<pre>public&nbsp;WrappedDataWatcher(java.lang.Object&nbsp;handle)</pre>
<div class="block">Create a wrapper for a given data watcher.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handle</code> - - the data watcher to wrap.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - If we're unable to wrap a DataWatcher.</dd></dl>
</li>
</ul>
<a name="WrappedDataWatcher(java.util.List)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WrappedDataWatcher</h4>
<pre>public&nbsp;WrappedDataWatcher(java.util.List&lt;<a href="../../../../com/comphenix/protocol/wrappers/WrappedWatchableObject.html" title="class in com.comphenix.protocol.wrappers">WrappedWatchableObject</a>&gt;&nbsp;watchableObjects)
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Create a new data watcher for a list of watchable objects.
<p>
Note that the watchable objects are not cloned, and will be modified in place. Use "deepClone" if
that is not desirable.
<p>
The <a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html#removeObject(int)"><code>removeObject(int)</code></a> method will not modify the given list, however.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>watchableObjects</code> - - list of watchable objects that will be copied.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - Unable to read watchable objects.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getHandle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHandle</h4>
<pre>public&nbsp;java.lang.Object&nbsp;getHandle()</pre>
<div class="block">Retrieves the underlying data watcher.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The underlying data watcher.</dd></dl>
</li>
</ul>
<a name="getTypeID(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypeID</h4>
<pre>public static&nbsp;java.lang.Integer&nbsp;getTypeID(java.lang.Class&lt;?&gt;&nbsp;clazz)
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Retrieve the ID of a given type, if it's allowed to be watched.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The ID, or NULL if it cannot be watched.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - If we cannot initialize the reflection machinery.</dd></dl>
</li>
</ul>
<a name="getTypeClass(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypeClass</h4>
<pre>public static&nbsp;java.lang.Class&lt;?&gt;&nbsp;getTypeClass(int&nbsp;id)
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Retrieve the type of a given ID, if it's allowed to be watched.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The type using a given ID, or NULL if it cannot be watched.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - If we cannot initialize the reflection machinery.</dd></dl>
</li>
</ul>
<a name="getByte(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getByte</h4>
<pre>public&nbsp;java.lang.Byte&nbsp;getByte(int&nbsp;index)
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Get a watched byte.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - - index of the watched byte.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The watched byte, or NULL if this value doesn't exist.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - Cannot read underlying field.</dd></dl>
</li>
</ul>
<a name="getShort(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShort</h4>
<pre>public&nbsp;java.lang.Short&nbsp;getShort(int&nbsp;index)
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Get a watched short.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - - index of the watched short.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The watched short, or NULL if this value doesn't exist.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - Cannot read underlying field.</dd></dl>
</li>
</ul>
<a name="getInteger(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInteger</h4>
<pre>public&nbsp;java.lang.Integer&nbsp;getInteger(int&nbsp;index)
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Get a watched integer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - - index of the watched integer.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The watched integer, or NULL if this value doesn't exist.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - Cannot read underlying field.</dd></dl>
</li>
</ul>
<a name="getFloat(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFloat</h4>
<pre>public&nbsp;java.lang.Float&nbsp;getFloat(int&nbsp;index)
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Get a watched float.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - - index of the watched float.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The watched float, or NULL if this value doesn't exist.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - Cannot read underlying field.</dd></dl>
</li>
</ul>
<a name="getString(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getString</h4>
<pre>public&nbsp;java.lang.String&nbsp;getString(int&nbsp;index)
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Get a watched string.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - - index of the watched string.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The watched string, or NULL if this value doesn't exist.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - Cannot read underlying field.</dd></dl>
</li>
</ul>
<a name="getItemStack(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getItemStack</h4>
<pre>public&nbsp;org.bukkit.inventory.ItemStack&nbsp;getItemStack(int&nbsp;index)
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Get a watched string.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - - index of the watched string.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The watched string, or NULL if this value doesn't exist.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - Cannot read underlying field.</dd></dl>
</li>
</ul>
<a name="getChunkCoordinate(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChunkCoordinate</h4>
<pre>public&nbsp;<a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html" title="class in com.comphenix.protocol.wrappers">WrappedChunkCoordinate</a>&nbsp;getChunkCoordinate(int&nbsp;index)
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Get a watched string.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - - index of the watched string.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The watched string, or NULL if this value doesn't exist.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - Cannot read underlying field.</dd></dl>
</li>
</ul>
<a name="getObject(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObject</h4>
<pre>public&nbsp;java.lang.Object&nbsp;getObject(int&nbsp;index)
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Retrieve a watchable object by index.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - - index of the object to retrieve.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The watched object.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - Cannot read underlying field.</dd></dl>
</li>
</ul>
<a name="getWatchableObjects()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWatchableObjects</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../com/comphenix/protocol/wrappers/WrappedWatchableObject.html" title="class in com.comphenix.protocol.wrappers">WrappedWatchableObject</a>&gt;&nbsp;getWatchableObjects()
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Retrieve every watchable object in this watcher.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Every watchable object.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - If reflection failed.</dd></dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="indexSet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexSet</h4>
<pre>public&nbsp;java.util.Set&lt;java.lang.Integer&gt;&nbsp;indexSet()
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Retrieve a copy of every index associated with a watched object.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Every watched object index.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - If we're unable to read the underlying object.</dd></dl>
</li>
</ul>
<a name="deepClone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deepClone</h4>
<pre>public&nbsp;<a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html" title="class in com.comphenix.protocol.wrappers">WrappedDataWatcher</a>&nbsp;deepClone()</pre>
<div class="block">Clone the content of the current DataWatcher.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A cloned data watcher.</dd></dl>
</li>
</ul>
<a name="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public&nbsp;int&nbsp;size()
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Retrieve the number of watched objects.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Watched object count.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - If we're unable to read the underlying object.</dd></dl>
</li>
</ul>
<a name="removeObject(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeObject</h4>
<pre>public&nbsp;<a href="../../../../com/comphenix/protocol/wrappers/WrappedWatchableObject.html" title="class in com.comphenix.protocol.wrappers">WrappedWatchableObject</a>&nbsp;removeObject(int&nbsp;index)</pre>
<div class="block">Remove a given object from the underlying DataWatcher.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - - index of the object to remove.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The watchable object that was removed, or NULL If none could be found.</dd></dl>
</li>
</ul>
<a name="setObject(int, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setObject</h4>
<pre>public&nbsp;void&nbsp;setObject(int&nbsp;index,
java.lang.Object&nbsp;newValue)
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Set a watched byte.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - - index of the watched byte.</dd><dd><code>newValue</code> - - the new watched value.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - Cannot read underlying field.</dd></dl>
</li>
</ul>
<a name="setObject(int, java.lang.Object, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setObject</h4>
<pre>public&nbsp;void&nbsp;setObject(int&nbsp;index,
java.lang.Object&nbsp;newValue,
boolean&nbsp;update)
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Set a watched byte.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - - index of the watched byte.</dd><dd><code>newValue</code> - - the new watched value.</dd><dd><code>update</code> - - whether or not to refresh every listening clients.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - Cannot read underlying field.</dd></dl>
</li>
</ul>
<a name="getReadWriteLock()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadWriteLock</h4>
<pre>protected&nbsp;java.util.concurrent.locks.ReadWriteLock&nbsp;getReadWriteLock()
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Retrieve the current read write lock.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Current read write lock.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - If we're unable to read the underlying field.</dd></dl>
</li>
</ul>
<a name="getWatchableObjectMap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWatchableObjectMap</h4>
<pre>protected&nbsp;java.util.Map&lt;java.lang.Integer,java.lang.Object&gt;&nbsp;getWatchableObjectMap()
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Retrieve the underlying map of key values that stores watchable objects.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A map of watchable objects.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - If we don't have permission to perform reflection.</dd></dl>
</li>
</ul>
<a name="getEntityWatcher(org.bukkit.entity.Entity)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntityWatcher</h4>
<pre>public static&nbsp;<a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html" title="class in com.comphenix.protocol.wrappers">WrappedDataWatcher</a>&nbsp;getEntityWatcher(org.bukkit.entity.Entity&nbsp;entity)
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Retrieve the data watcher associated with an entity.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entity</code> - - the entity to read from.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Associated data watcher.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - Reflection failed.</dd></dl>
</li>
</ul>
<a name="iterator()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>iterator</h4>
<pre>public&nbsp;java.util.Iterator&lt;<a href="../../../../com/comphenix/protocol/wrappers/WrappedWatchableObject.html" title="class in com.comphenix.protocol.wrappers">WrappedWatchableObject</a>&gt;&nbsp;iterator()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>iterator</code>&nbsp;in interface&nbsp;<code>java.lang.Iterable&lt;<a href="../../../../com/comphenix/protocol/wrappers/WrappedWatchableObject.html" title="class in com.comphenix.protocol.wrappers">WrappedWatchableObject</a>&gt;</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/WrappedDataWatcher.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html" title="class in com.comphenix.protocol.wrappers"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/comphenix/protocol/wrappers/WrappedWatchableObject.html" title="class in com.comphenix.protocol.wrappers"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/comphenix/protocol/wrappers/WrappedDataWatcher.html" target="_top">Frames</a></li>
<li><a href="WrappedDataWatcher.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink