ProtocolLib/Javadoc/com/comphenix/protocol/reflect/IntEnum.html
2012-12-10 16:45:24 +01:00

396 lines
14 KiB
HTML

<!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 Mon Dec 10 16:44:14 CET 2012 -->
<title>IntEnum</title>
<meta name="date" content="2012-12-10">
<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="IntEnum";
}
//-->
</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/IntEnum.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/reflect/FuzzyReflection.html" title="class in com.comphenix.protocol.reflect"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/comphenix/protocol/reflect/MethodUtils.html" title="class in com.comphenix.protocol.reflect"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/comphenix/protocol/reflect/IntEnum.html" target="_top">Frames</a></li>
<li><a href="IntEnum.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.reflect</div>
<h2 title="Class IntEnum" class="title">Class IntEnum</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.comphenix.protocol.reflect.IntEnum</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../com/comphenix/protocol/Packets.Client.html" title="class in com.comphenix.protocol">Packets.Client</a>, <a href="../../../../com/comphenix/protocol/Packets.Server.html" title="class in com.comphenix.protocol">Packets.Server</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">IntEnum</span>
extends java.lang.Object</pre>
<div class="block">Represents a traditional int field enum.</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 com.google.common.collect.BiMap&lt;java.lang.Integer,java.lang.String&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/reflect/IntEnum.html#members">members</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/reflect/IntEnum.html#IntEnum()">IntEnum</a></strong>()</code>
<div class="block">Registers every declared integer field.</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>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/reflect/IntEnum.html#getDeclaredName(java.lang.Integer)">getDeclaredName</a></strong>(java.lang.Integer&nbsp;id)</code>
<div class="block">Retrieve the name of the member with the given id.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/reflect/IntEnum.html#hasMember(int)">hasMember</a></strong>(int&nbsp;id)</code>
<div class="block">Determines whether or not the given member exists.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/reflect/IntEnum.html#registerAll()">registerAll</a></strong>()</code>
<div class="block">Registers every public int field as a member.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/reflect/IntEnum.html#registerMember(int, java.lang.String)">registerMember</a></strong>(int&nbsp;id,
java.lang.String&nbsp;name)</code>
<div class="block">Registers a member.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Integer</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/reflect/IntEnum.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String&nbsp;name)</code>
<div class="block">Retrieve the ID of the member with the given name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.Integer&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/reflect/IntEnum.html#values()">values</a></strong>()</code>
<div class="block">Retrieve the ID of every registered member.</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, equals, finalize, getClass, hashCode, 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="members">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>members</h4>
<pre>protected&nbsp;com.google.common.collect.BiMap&lt;java.lang.Integer,java.lang.String&gt; members</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="IntEnum()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IntEnum</h4>
<pre>public&nbsp;IntEnum()</pre>
<div class="block">Registers every declared integer field.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="registerAll()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerAll</h4>
<pre>protected&nbsp;void&nbsp;registerAll()</pre>
<div class="block">Registers every public int field as a member.</div>
</li>
</ul>
<a name="registerMember(int, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerMember</h4>
<pre>protected&nbsp;void&nbsp;registerMember(int&nbsp;id,
java.lang.String&nbsp;name)</pre>
<div class="block">Registers a member.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - - id of member.</dd><dd><code>name</code> - - name of member.</dd></dl>
</li>
</ul>
<a name="hasMember(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasMember</h4>
<pre>public&nbsp;boolean&nbsp;hasMember(int&nbsp;id)</pre>
<div class="block">Determines whether or not the given member exists.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - - the ID of the member to find.</dd>
<dt><span class="strong">Returns:</span></dt><dd>TRUE if a member with the given ID exists, FALSE otherwise.</dd></dl>
</li>
</ul>
<a name="valueOf(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public&nbsp;java.lang.Integer&nbsp;valueOf(java.lang.String&nbsp;name)</pre>
<div class="block">Retrieve the ID of the member with the given name.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - - name of member to retrieve.</dd>
<dt><span class="strong">Returns:</span></dt><dd>ID of the member, or NULL if not found.</dd></dl>
</li>
</ul>
<a name="getDeclaredName(java.lang.Integer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeclaredName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getDeclaredName(java.lang.Integer&nbsp;id)</pre>
<div class="block">Retrieve the name of the member with the given id.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - - id of the member to retrieve.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Declared name of the member, or NULL if not found.</dd></dl>
</li>
</ul>
<a name="values()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>values</h4>
<pre>public&nbsp;java.util.Set&lt;java.lang.Integer&gt;&nbsp;values()</pre>
<div class="block">Retrieve the ID of every registered member.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Enumeration of every value.</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/IntEnum.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/reflect/FuzzyReflection.html" title="class in com.comphenix.protocol.reflect"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/comphenix/protocol/reflect/MethodUtils.html" title="class in com.comphenix.protocol.reflect"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/comphenix/protocol/reflect/IntEnum.html" target="_top">Frames</a></li>
<li><a href="IntEnum.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>