Upstream/ProtocolLib
1
0
Fork 0
mirror of https://github.com/dmulloy2/ProtocolLib.git synced 2024-11-29 06:05:42 +01:00
Code Issues Projects Releases Wiki Activity
f232823820
ProtocolLib/Javadoc/com/comphenix/protocol/reflect/instances/DefaultInstances.html

445 lines
21 KiB
HTML
Raw Normal View History

Adding the new javadoc.
2012-09-18 17:27:59 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
Regenerated JavaDoc.
2012-09-18 18:41:24 +02:00
<!-- Generated by javadoc (version 1.7.0_07) on Tue Sep 18 18:41:10 CEST 2012 -->
Adding the new javadoc.
2012-09-18 17:27:59 +02:00
<title>DefaultInstances</title>
<meta name="date" content="2012-09-18">
<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="DefaultInstances";
}
//-->
</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/DefaultInstances.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/CollectionGenerator.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/DefaultInstances.html" target="_top">Frames</a></li>
<li><a href="DefaultInstances.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.instances</div>
<h2 title="Class DefaultInstances" class="title">Class DefaultInstances</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.comphenix.protocol.reflect.instances.DefaultInstances</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">DefaultInstances</span>
extends java.lang.Object</pre>
<div class="block">Used to construct default instances of any type.</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>static <a href="../../../../../com/comphenix/protocol/reflect/instances/DefaultInstances.html" title="class in com.comphenix.protocol.reflect.instances">DefaultInstances</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/instances/DefaultInstances.html#DEFAULT">DEFAULT</a></strong></code>
<div class="block">Standard default instance provider.</div>
</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/instances/DefaultInstances.html#DefaultInstances(com.google.common.collect.ImmutableList)">DefaultInstances</a></strong>(com.google.common.collect.ImmutableList&lt;<a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a>&gt;&nbsp;registered)</code>
<div class="block">Construct a default instance generator using the given instance providers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/instances/DefaultInstances.html#DefaultInstances(com.comphenix.protocol.reflect.instances.InstanceProvider...)">DefaultInstances</a></strong>(<a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a>...&nbsp;instaceProviders)</code>
<div class="block">Construct a default instance generator using the given instance providers.</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 &lt;T&gt;&nbsp;boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/instances/DefaultInstances.html#contains(T[], T)">contains</a></strong>(T[]&nbsp;elements,
T&nbsp;elementToFind)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected &lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/instances/DefaultInstances.html#createInstance(java.lang.Class, java.lang.reflect.Constructor, java.lang.Class[], java.lang.Object[])">createInstance</a></strong>(java.lang.Class&lt;T&gt;&nbsp;type,
java.lang.reflect.Constructor&lt;T&gt;&nbsp;constructor,
java.lang.Class&lt;?&gt;[]&nbsp;types,
java.lang.Object[]&nbsp;params)</code>
<div class="block">Used by the default instance provider to create a class from a given constructor.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../com/comphenix/protocol/reflect/instances/DefaultInstances.html" title="class in com.comphenix.protocol.reflect.instances">DefaultInstances</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/instances/DefaultInstances.html#fromArray(com.comphenix.protocol.reflect.instances.InstanceProvider...)">fromArray</a></strong>(<a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a>...&nbsp;instaceProviders)</code>
<div class="block">Construct a default instance generator using the given instance providers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/instances/DefaultInstances.html#getDefault(java.lang.Class)">getDefault</a></strong>(java.lang.Class&lt;T&gt;&nbsp;type)</code>
<div class="block">Retrieves a default instance or value that is assignable to this type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/instances/DefaultInstances.html#getDefault(java.lang.Class, java.util.List)">getDefault</a></strong>(java.lang.Class&lt;T&gt;&nbsp;type,
java.util.List&lt;<a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a>&gt;&nbsp;providers)</code>
<div class="block">Retrieves a default instance or value that is assignable to this type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>com.google.common.collect.ImmutableList&lt;<a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/instances/DefaultInstances.html#getRegistered()">getRegistered</a></strong>()</code>
<div class="block">Retrieves a immutable list of every default object providers that generates instances.</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="DEFAULT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT</h4>
<pre>public static&nbsp;<a href="../../../../../com/comphenix/protocol/reflect/instances/DefaultInstances.html" title="class in com.comphenix.protocol.reflect.instances">DefaultInstances</a> DEFAULT</pre>
<div class="block">Standard default instance provider.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DefaultInstances(com.google.common.collect.ImmutableList)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DefaultInstances</h4>
<pre>public&nbsp;DefaultInstances(com.google.common.collect.ImmutableList&lt;<a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a>&gt;&nbsp;registered)</pre>
<div class="block">Construct a default instance generator using the given instance providers.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>registered</code> - - list of instance providers.</dd></dl>
</li>
</ul>
<a name="DefaultInstances(com.comphenix.protocol.reflect.instances.InstanceProvider...)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DefaultInstances</h4>
<pre>public&nbsp;DefaultInstances(<a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a>...&nbsp;instaceProviders)</pre>
<div class="block">Construct a default instance generator using the given instance providers.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instaceProviders</code> - - array of instance providers.</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="fromArray(com.comphenix.protocol.reflect.instances.InstanceProvider...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromArray</h4>
<pre>public static&nbsp;<a href="../../../../../com/comphenix/protocol/reflect/instances/DefaultInstances.html" title="class in com.comphenix.protocol.reflect.instances">DefaultInstances</a>&nbsp;fromArray(<a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a>...&nbsp;instaceProviders)</pre>
<div class="block">Construct a default instance generator using the given instance providers.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instaceProviders</code> - - array of instance providers.</dd>
<dt><span class="strong">Returns:</span></dt><dd>An default instance generator.</dd></dl>
</li>
</ul>
<a name="getRegistered()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRegistered</h4>
<pre>public&nbsp;com.google.common.collect.ImmutableList&lt;<a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a>&gt;&nbsp;getRegistered()</pre>
<div class="block">Retrieves a immutable list of every default object providers that generates instances.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Table of instance providers.</dd></dl>
</li>
</ul>
<a name="getDefault(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefault</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;T&nbsp;getDefault(java.lang.Class&lt;T&gt;&nbsp;type)</pre>
<div class="block">Retrieves a default instance or value that is assignable to this type.
<p>
This includes, but isn't limited too:
<ul>
<li>Primitive types. Returns either zero or null.</li>
<li>Primitive wrappers.</li>
<li>String types. Returns an empty string.</li>
<li>Arrays. Returns a zero-length array of the same type.</li>
<li>Enums. Returns the first declared element.</li>
<li>Collection interfaces, such as List and Set. Returns the most appropriate empty container.</li>
<li>Any type with a public constructor that has parameters with defaults.</li>
</ul>
</ul></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - - the type to construct a default value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A default value/instance, or NULL if not possible.</dd></dl>
</li>
</ul>
<a name="getDefault(java.lang.Class, java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefault</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;T&nbsp;getDefault(java.lang.Class&lt;T&gt;&nbsp;type,
java.util.List&lt;<a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a>&gt;&nbsp;providers)</pre>
<div class="block">Retrieves a default instance or value that is assignable to this type.
<p>
This includes, but isn't limited too:
<ul>
<li>Primitive types. Returns either zero or null.</li>
<li>Primitive wrappers.</li>
<li>String types. Returns an empty string.</li>
<li>Arrays. Returns a zero-length array of the same type.</li>
<li>Enums. Returns the first declared element.</li>
<li>Collection interfaces, such as List and Set. Returns the most appropriate empty container.</li>
<li>Any type with a public constructor that has parameters with defaults.</li>
</ul>
</ul></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - - the type to construct a default value.</dd><dd><code>providers</code> - - instance providers used during the</dd>
<dt><span class="strong">Returns:</span></dt><dd>A default value/instance, or NULL if not possible.</dd></dl>
</li>
</ul>
<a name="createInstance(java.lang.Class, java.lang.reflect.Constructor, java.lang.Class[], java.lang.Object[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createInstance</h4>
<pre>protected&nbsp;&lt;T&gt;&nbsp;T&nbsp;createInstance(java.lang.Class&lt;T&gt;&nbsp;type,
java.lang.reflect.Constructor&lt;T&gt;&nbsp;constructor,
java.lang.Class&lt;?&gt;[]&nbsp;types,
java.lang.Object[]&nbsp;params)</pre>
<div class="block">Used by the default instance provider to create a class from a given constructor.
The default method uses reflection.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - - the type to create.</dd><dd><code>constructor</code> - - the constructor to use.</dd><dd><code>types</code> - - type of each parameter in order.</dd><dd><code>params</code> - - value of each parameter in order.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The constructed instance.</dd></dl>
</li>
</ul>
<a name="contains(java.lang.Object[],java.lang.Object)">
<!-- -->
</a><a name="contains(T[], T)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>contains</h4>
<pre>protected&nbsp;&lt;T&gt;&nbsp;boolean&nbsp;contains(T[]&nbsp;elements,
T&nbsp;elementToFind)</pre>
</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/DefaultInstances.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/CollectionGenerator.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/DefaultInstances.html" target="_top">Frames</a></li>
<li><a href="DefaultInstances.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 Copy Permalink