Upstream/ProtocolLib
1
0
Fork 0
mirror of https://github.com/dmulloy2/ProtocolLib.git synced 2024-12-05 00:54:04 +01:00
Code Issues Projects Releases Wiki Activity
6ed5d4687d
ProtocolLib/Javadoc/com/comphenix/protocol/reflect/instances/ExistingGenerator.html
Kristian S. Stangeland 6ed5d4687d Updating JavaDoc for 2.1.0
2013-01-22 13:29:54 +01:00

305 lines
13 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 Tue Jan 22 13:27:27 CET 2013 -->
<title>ExistingGenerator</title>
<meta name="date" content="2013-01-22">
<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="ExistingGenerator";
}
//-->
</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/ExistingGenerator.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/instances/DefaultInstances.html" title="class in com.comphenix.protocol.reflect.instances"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/comphenix/protocol/reflect/instances/ExistingGenerator.html" target="_top">Frames</a></li>
<li><a href="ExistingGenerator.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>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.instances</div>
<h2 title="Class ExistingGenerator" class="title">Class ExistingGenerator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.comphenix.protocol.reflect.instances.ExistingGenerator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ExistingGenerator</span>
extends java.lang.Object
implements <a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a></pre>
<div class="block">Provides instance constructors using a list of existing values.
<p>
Only one instance per individual class.</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">
<!-- ========== 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.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/instances/ExistingGenerator.html#create(java.lang.Class)">create</a></strong>(java.lang.Class&lt;?&gt;&nbsp;type)</code>
<div class="block">Create an instance given a type, if possible.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../com/comphenix/protocol/reflect/instances/ExistingGenerator.html" title="class in com.comphenix.protocol.reflect.instances">ExistingGenerator</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/instances/ExistingGenerator.html#fromObjectArray(java.lang.Object[])">fromObjectArray</a></strong>(java.lang.Object[]&nbsp;values)</code>
<div class="block">Create an instance generator from a pre-defined array of values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../com/comphenix/protocol/reflect/instances/ExistingGenerator.html" title="class in com.comphenix.protocol.reflect.instances">ExistingGenerator</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/instances/ExistingGenerator.html#fromObjectFields(java.lang.Object)">fromObjectFields</a></strong>(java.lang.Object&nbsp;object)</code>
<div class="block">Automatically create an instance provider from a objects public and private fields.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../com/comphenix/protocol/reflect/instances/ExistingGenerator.html" title="class in com.comphenix.protocol.reflect.instances">ExistingGenerator</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/instances/ExistingGenerator.html#fromObjectFields(java.lang.Object, java.lang.Class)">fromObjectFields</a></strong>(java.lang.Object&nbsp;object,
java.lang.Class&lt;?&gt;&nbsp;type)</code>
<div class="block">Automatically create an instance provider from a objects public and private fields.</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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="fromObjectFields(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromObjectFields</h4>
<pre>public static&nbsp;<a href="../../../../../com/comphenix/protocol/reflect/instances/ExistingGenerator.html" title="class in com.comphenix.protocol.reflect.instances">ExistingGenerator</a>&nbsp;fromObjectFields(java.lang.Object&nbsp;object)</pre>
<div class="block">Automatically create an instance provider from a objects public and private fields.
<p>
If two or more fields share the same type, the last declared non-null field will take
precedent.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>object</code> - - object to create an instance generator from.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The instance generator.</dd></dl>
</li>
</ul>
<a name="fromObjectFields(java.lang.Object, java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromObjectFields</h4>
<pre>public static&nbsp;<a href="../../../../../com/comphenix/protocol/reflect/instances/ExistingGenerator.html" title="class in com.comphenix.protocol.reflect.instances">ExistingGenerator</a>&nbsp;fromObjectFields(java.lang.Object&nbsp;object,
java.lang.Class&lt;?&gt;&nbsp;type)</pre>
<div class="block">Automatically create an instance provider from a objects public and private fields.
<p>
If two or more fields share the same type, the last declared non-null field will take
precedent.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>object</code> - - object to create an instance generator from.</dd><dd><code>type</code> - - the type to cast the object.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The instance generator.</dd></dl>
</li>
</ul>
<a name="fromObjectArray(java.lang.Object[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromObjectArray</h4>
<pre>public static&nbsp;<a href="../../../../../com/comphenix/protocol/reflect/instances/ExistingGenerator.html" title="class in com.comphenix.protocol.reflect.instances">ExistingGenerator</a>&nbsp;fromObjectArray(java.lang.Object[]&nbsp;values)</pre>
<div class="block">Create an instance generator from a pre-defined array of values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - - values to provide.</dd>
<dt><span class="strong">Returns:</span></dt><dd>An instance provider that uses these values.</dd></dl>
</li>
</ul>
<a name="create(java.lang.Class)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>create</h4>
<pre>public&nbsp;java.lang.Object&nbsp;create(@Nullable
java.lang.Class&lt;?&gt;&nbsp;type)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html#create(java.lang.Class)">InstanceProvider</a></code></strong></div>
<div class="block">Create an instance given a type, if possible.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html#create(java.lang.Class)">create</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - - type to create.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The instance, or NULL if the type cannot be created.</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/ExistingGenerator.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/instances/DefaultInstances.html" title="class in com.comphenix.protocol.reflect.instances"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/comphenix/protocol/reflect/instances/ExistingGenerator.html" target="_top">Frames</a></li>
<li><a href="ExistingGenerator.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>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>
Reference in New Issue View Git Blame Copy Permalink