SteamWar/ProtocolLib
Archiviert
13
0
Fork 0
Code Issues Pull-Requests Releases Wiki Aktivität
Dieses Repository wurde am 2021-01-06 archiviert. Du kannst Dateien ansehen und es klonen, aber nicht pushen oder Issues/Pull-Requests öffnen.
7e20abdd37
ProtocolLib/Javadoc/com/comphenix/protocol/reflect/fuzzy/FuzzyClassContract.html

393 Zeilen
19 KiB
HTML
Originalformat Normale Ansicht Verlauf

Updating JavaDoc for 2.2.0
2013-02-05 23:35:15 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
Update JavaDoc for 2.3.0
2013-03-05 17:07:09 +01:00
<!-- Generated by javadoc (version 1.7.0_13) on Tue Mar 05 17:05:45 CET 2013 -->
Updating JavaDoc for 2.2.0
2013-02-05 23:35:15 +01:00
<title>FuzzyClassContract</title>
Update JavaDoc for 2.3.0
2013-03-05 17:07:09 +01:00
<meta name="date" content="2013-03-05">
Updating JavaDoc for 2.2.0
2013-02-05 23:35:15 +01:00
<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="FuzzyClassContract";
}
//-->
</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/FuzzyClassContract.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/fuzzy/AbstractFuzzyMember.Builder.html" title="class in com.comphenix.protocol.reflect.fuzzy"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyClassContract.Builder.html" title="class in com.comphenix.protocol.reflect.fuzzy"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/comphenix/protocol/reflect/fuzzy/FuzzyClassContract.html" target="_top">Frames</a></li>
<li><a href="FuzzyClassContract.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><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.fuzzy</div>
<h2 title="Class FuzzyClassContract" class="title">Class FuzzyClassContract</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html" title="class in com.comphenix.protocol.reflect.fuzzy">com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMatcher</a>&lt;java.lang.Class&lt;?&gt;&gt;</li>
<li>
<ul class="inheritance">
<li>com.comphenix.protocol.reflect.fuzzy.FuzzyClassContract</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Comparable&lt;<a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMatcher</a>&lt;java.lang.Class&lt;?&gt;&gt;&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">FuzzyClassContract</span>
extends <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMatcher</a>&lt;java.lang.Class&lt;?&gt;&gt;</pre>
<div class="block">Determine if a given class implements a given fuzzy (duck typed) contract.</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">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyClassContract.Builder.html" title="class in com.comphenix.protocol.reflect.fuzzy">FuzzyClassContract.Builder</a></strong></code>
<div class="block">Represents a class contract builder.</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>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyClassContract.html#calculateRoundNumber()">calculateRoundNumber</a></strong>()</code>
<div class="block">Calculate the round number indicating when this matcher should be applied.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>com.google.common.collect.ImmutableList&lt;<a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMatcher</a>&lt;<a href="../../../../../com/comphenix/protocol/reflect/MethodInfo.html" title="class in com.comphenix.protocol.reflect">MethodInfo</a>&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyClassContract.html#getConstructorContracts()">getConstructorContracts</a></strong>()</code>
<div class="block">Retrieve an immutable list of every constructor contract.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>com.google.common.collect.ImmutableList&lt;<a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMatcher</a>&lt;java.lang.reflect.Field&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyClassContract.html#getFieldContracts()">getFieldContracts</a></strong>()</code>
<div class="block">Retrieve an immutable list of every field contract.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>com.google.common.collect.ImmutableList&lt;<a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMatcher</a>&lt;<a href="../../../../../com/comphenix/protocol/reflect/MethodInfo.html" title="class in com.comphenix.protocol.reflect">MethodInfo</a>&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyClassContract.html#getMethodContracts()">getMethodContracts</a></strong>()</code>
<div class="block">Retrieve an immutable list of every method contract.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyClassContract.html#isMatch(java.lang.Class, java.lang.Object)">isMatch</a></strong>(java.lang.Class&lt;?&gt;&nbsp;value,
java.lang.Object&nbsp;parent)</code>
<div class="block">Determine if the given value is a match.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyClassContract.Builder.html" title="class in com.comphenix.protocol.reflect.fuzzy">FuzzyClassContract.Builder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyClassContract.html#newBuilder()">newBuilder</a></strong>()</code>
<div class="block">Construct a new fuzzy class contract builder.</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/reflect/fuzzy/FuzzyClassContract.html#toString()">toString</a></strong>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMatcher">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.comphenix.protocol.reflect.fuzzy.<a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMatcher</a></h3>
<code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html#and(com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMatcher)">and</a>, <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html#combineRounds(int, int)">combineRounds</a>, <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html#compareTo(com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMatcher)">compareTo</a>, <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html#getRoundNumber()">getRoundNumber</a>, <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html#inverted()">inverted</a>, <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html#or(com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMatcher)">or</a></code></li>
</ul>
<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, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="newBuilder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newBuilder</h4>
<pre>public static&nbsp;<a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyClassContract.Builder.html" title="class in com.comphenix.protocol.reflect.fuzzy">FuzzyClassContract.Builder</a>&nbsp;newBuilder()</pre>
<div class="block">Construct a new fuzzy class contract builder.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A new builder.</dd></dl>
</li>
</ul>
<a name="getFieldContracts()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldContracts</h4>
<pre>public&nbsp;com.google.common.collect.ImmutableList&lt;<a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMatcher</a>&lt;java.lang.reflect.Field&gt;&gt;&nbsp;getFieldContracts()</pre>
<div class="block">Retrieve an immutable list of every field contract.
<p>
This list is ordered in descending order of priority.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>List of every field contract.</dd></dl>
</li>
</ul>
<a name="getMethodContracts()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMethodContracts</h4>
<pre>public&nbsp;com.google.common.collect.ImmutableList&lt;<a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMatcher</a>&lt;<a href="../../../../../com/comphenix/protocol/reflect/MethodInfo.html" title="class in com.comphenix.protocol.reflect">MethodInfo</a>&gt;&gt;&nbsp;getMethodContracts()</pre>
<div class="block">Retrieve an immutable list of every method contract.
<p>
This list is ordered in descending order of priority.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>List of every method contract.</dd></dl>
</li>
</ul>
<a name="getConstructorContracts()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConstructorContracts</h4>
<pre>public&nbsp;com.google.common.collect.ImmutableList&lt;<a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMatcher</a>&lt;<a href="../../../../../com/comphenix/protocol/reflect/MethodInfo.html" title="class in com.comphenix.protocol.reflect">MethodInfo</a>&gt;&gt;&nbsp;getConstructorContracts()</pre>
<div class="block">Retrieve an immutable list of every constructor contract.
<p>
This list is ordered in descending order of priority.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>List of every constructor contract.</dd></dl>
</li>
</ul>
<a name="calculateRoundNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>calculateRoundNumber</h4>
<pre>protected&nbsp;int&nbsp;calculateRoundNumber()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html#calculateRoundNumber()">AbstractFuzzyMatcher</a></code></strong></div>
<div class="block">Calculate the round number indicating when this matcher should be applied.
<p>
Matchers with a lower round number are applied before matchers with a higher round number.
<p>
By convention, this round number should be negative, except for zero in the case of a matcher
that accepts any value. A good implementation should return the inverted tree depth (class hierachy)
of the least specified type used in the matching. Thus <code>Integer</code> will have a lower round number than
<code>Number</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html#calculateRoundNumber()">calculateRoundNumber</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMatcher</a>&lt;java.lang.Class&lt;?&gt;&gt;</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>A number (positive or negative) that is used to order matchers.</dd></dl>
</li>
</ul>
<a name="isMatch(java.lang.Class, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMatch</h4>
<pre>public&nbsp;boolean&nbsp;isMatch(java.lang.Class&lt;?&gt;&nbsp;value,
java.lang.Object&nbsp;parent)</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html#isMatch(T, java.lang.Object)">AbstractFuzzyMatcher</a></code></strong></div>
<div class="block">Determine if the given value is a match.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html#isMatch(T, java.lang.Object)">isMatch</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMatcher</a>&lt;java.lang.Class&lt;?&gt;&gt;</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - - the value to match.</dd><dd><code>parent</code> - - the parent container, or NULL if this value is the root.</dd>
<dt><span class="strong">Returns:</span></dt><dd>TRUE if it is a match, FALSE otherwise.</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</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/FuzzyClassContract.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/fuzzy/AbstractFuzzyMember.Builder.html" title="class in com.comphenix.protocol.reflect.fuzzy"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyClassContract.Builder.html" title="class in com.comphenix.protocol.reflect.fuzzy"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/comphenix/protocol/reflect/fuzzy/FuzzyClassContract.html" target="_top">Frames</a></li>
<li><a href="FuzzyClassContract.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><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>
In neuem Issue referenzieren Permalink kopieren