<!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_21) on Tue May 14 01:28:31 CEST 2013 --> <title>FuzzyFieldContract</title> <meta name="date" content="2013-05-14"> <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="FuzzyFieldContract"; } //--> </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/FuzzyFieldContract.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/FuzzyClassContract.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/FuzzyFieldContract.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/FuzzyFieldContract.html" target="_top">Frames</a></li> <li><a href="FuzzyFieldContract.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: </li> <li><a href="#nested_class_summary">Nested</a> | </li> <li><a href="#fields_inherited_from_class_com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMember">Field</a> | </li> <li>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </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 FuzzyFieldContract" class="title">Class FuzzyFieldContract</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><T></li> <li> <ul class="inheritance"> <li><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html" title="class in com.comphenix.protocol.reflect.fuzzy">com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMember</a><java.lang.reflect.Field></li> <li> <ul class="inheritance"> <li>com.comphenix.protocol.reflect.fuzzy.FuzzyFieldContract</li> </ul> </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<<a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMatcher</a><java.lang.reflect.Field>></dd> </dl> <hr> <br> <pre>public class <span class="strong">FuzzyFieldContract</span> extends <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMember</a><java.lang.reflect.Field></pre> <div class="block">Represents a field matcher.</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"> </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 </code></td> <td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyFieldContract.Builder.html" title="class in com.comphenix.protocol.reflect.fuzzy">FuzzyFieldContract.Builder</a></strong></code> <div class="block">Represents a builder for a field matcher.</div> </td> </tr> </table> </li> </ul> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field_summary"> <!-- --> </a> <h3>Field Summary</h3> <ul class="blockList"> <li class="blockList"><a name="fields_inherited_from_class_com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMember"> <!-- --> </a> <h3>Fields inherited from class com.comphenix.protocol.reflect.fuzzy.<a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMember</a></h3> <code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#declaringMatcher">declaringMatcher</a>, <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#modifiersBanned">modifiersBanned</a>, <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#modifiersRequired">modifiersRequired</a>, <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#nameRegex">nameRegex</a>, <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#sealed">sealed</a></code></li> </ul> </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"> </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/FuzzyFieldContract.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>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyFieldContract.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected java.util.Map<java.lang.String,java.lang.Object></code></td> <td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyFieldContract.html#getKeyValueView()">getKeyValueView</a></strong>()</code> <div class="block">Generate a view of this matcher as a key-value map.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMatcher</a><java.lang.Class<?>></code></td> <td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyFieldContract.html#getTypeMatcher()">getTypeMatcher</a></strong>()</code> <div class="block">Retrieve the class matcher that matches the type of a field.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyFieldContract.html#hashCode()">hashCode</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyFieldContract.html#isMatch(java.lang.reflect.Field, java.lang.Object)">isMatch</a></strong>(java.lang.reflect.Field value, java.lang.Object parent)</code> <div class="block">Determine if the given value is a match.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyFieldContract.Builder.html" title="class in com.comphenix.protocol.reflect.fuzzy">FuzzyFieldContract.Builder</a></code></td> <td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyFieldContract.html#newBuilder()">newBuilder</a></strong>()</code> <div class="block">Return a new fuzzy field contract builder.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMember"> <!-- --> </a> <h3>Methods inherited from class com.comphenix.protocol.reflect.fuzzy.<a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMember</a></h3> <code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#getDeclaringMatcher()">getDeclaringMatcher</a>, <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#getModifiersBanned()">getModifiersBanned</a>, <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#getModifiersRequired()">getModifiersRequired</a>, <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#getNameRegex()">getNameRegex</a>, <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#prepareBuild()">prepareBuild</a>, <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#toString()">toString</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMatcher"> <!-- --> </a> <h3>Methods inherited from class 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(java.lang.Integer...)">combineRounds</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 java.lang.Object</h3> <code>clone, finalize, getClass, 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 <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/FuzzyFieldContract.Builder.html" title="class in com.comphenix.protocol.reflect.fuzzy">FuzzyFieldContract.Builder</a> newBuilder()</pre> <div class="block">Return a new fuzzy field contract builder.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>New fuzzy field contract builder.</dd></dl> </li> </ul> <a name="getTypeMatcher()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getTypeMatcher</h4> <pre>public <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMatcher.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMatcher</a><java.lang.Class<?>> getTypeMatcher()</pre> <div class="block">Retrieve the class matcher that matches the type of a field.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>The class matcher.</dd></dl> </li> </ul> <a name="isMatch(java.lang.reflect.Field, java.lang.Object)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isMatch</h4> <pre>public boolean isMatch(java.lang.reflect.Field value, java.lang.Object parent)</pre> <div class="block"><strong>Description copied from class: <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>Overrides:</strong></dt> <dd><code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#isMatch(T, java.lang.Object)">isMatch</a></code> in class <code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMember</a><java.lang.reflect.Field></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="calculateRoundNumber()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>calculateRoundNumber</h4> <pre>protected int calculateRoundNumber()</pre> <div class="block"><strong>Description copied from class: <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>Overrides:</strong></dt> <dd><code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#calculateRoundNumber()">calculateRoundNumber</a></code> in class <code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMember</a><java.lang.reflect.Field></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="getKeyValueView()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getKeyValueView</h4> <pre>protected java.util.Map<java.lang.String,java.lang.Object> getKeyValueView()</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#getKeyValueView()">AbstractFuzzyMember</a></code></strong></div> <div class="block">Generate a view of this matcher as a key-value map. <p> Used by <a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#toString()"><code>AbstractFuzzyMember.toString()</code></a> to print a representation of this object.</div> <dl> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#getKeyValueView()">getKeyValueView</a></code> in class <code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMember</a><java.lang.reflect.Field></code></dd> <dt><span class="strong">Returns:</span></dt><dd>A modifiable key-value view.</dd></dl> </li> </ul> <a name="hashCode()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hashCode</h4> <pre>public int hashCode()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#hashCode()">hashCode</a></code> in class <code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMember</a><java.lang.reflect.Field></code></dd> </dl> </li> </ul> <a name="equals(java.lang.Object)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>equals</h4> <pre>public boolean equals(java.lang.Object obj)</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="../../../../../com/comphenix/protocol/reflect/fuzzy/AbstractFuzzyMember.html" title="class in com.comphenix.protocol.reflect.fuzzy">AbstractFuzzyMember</a><java.lang.reflect.Field></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/FuzzyFieldContract.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/FuzzyClassContract.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/FuzzyFieldContract.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/FuzzyFieldContract.html" target="_top">Frames</a></li> <li><a href="FuzzyFieldContract.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: </li> <li><a href="#nested_class_summary">Nested</a> | </li> <li><a href="#fields_inherited_from_class_com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMember">Field</a> | </li> <li>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </body> </html>