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.
599e3b8828
ProtocolLib/Javadoc/com/comphenix/protocol/reflect/cloning/FieldCloner.html

423 Zeilen
20 KiB
HTML
Originalformat Normale Ansicht Verlauf

Updated JavaDoc for 1.9.0
2012-12-27 17:44:04 +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>
<!-- Generated by javadoc (version 1.7.0_07) on Thu Dec 27 17:42:38 CET 2012 -->
<title>FieldCloner</title>
<meta name="date" content="2012-12-27">
<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="FieldCloner";
}
//-->
</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/FieldCloner.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/cloning/CollectionCloner.html" title="class in com.comphenix.protocol.reflect.cloning"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../com/comphenix/protocol/reflect/cloning/ImmutableDetector.html" title="class in com.comphenix.protocol.reflect.cloning"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/comphenix/protocol/reflect/cloning/FieldCloner.html" target="_top">Frames</a></li>
<li><a href="FieldCloner.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.cloning</div>
<h2 title="Class FieldCloner" class="title">Class FieldCloner</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.comphenix.protocol.reflect.cloning.FieldCloner</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/cloning/Cloner.html" title="interface in com.comphenix.protocol.reflect.cloning">Cloner</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">FieldCloner</span>
extends java.lang.Object
implements <a href="../../../../../com/comphenix/protocol/reflect/cloning/Cloner.html" title="interface in com.comphenix.protocol.reflect.cloning">Cloner</a></pre>
<div class="block">Represents a class capable of cloning objects by deeply copying its fields.</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 <a href="../../../../../com/comphenix/protocol/reflect/cloning/Cloner.html" title="interface in com.comphenix.protocol.reflect.cloning">Cloner</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/cloning/FieldCloner.html#defaultCloner">defaultCloner</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/cloning/FieldCloner.html#instanceProvider">instanceProvider</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../com/comphenix/protocol/reflect/ObjectWriter.html" title="class in com.comphenix.protocol.reflect">ObjectWriter</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/cloning/FieldCloner.html#writer">writer</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/cloning/FieldCloner.html#FieldCloner(com.comphenix.protocol.reflect.cloning.Cloner, com.comphenix.protocol.reflect.instances.InstanceProvider)">FieldCloner</a></strong>(<a href="../../../../../com/comphenix/protocol/reflect/cloning/Cloner.html" title="interface in com.comphenix.protocol.reflect.cloning">Cloner</a>&nbsp;defaultCloner,
<a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a>&nbsp;instanceProvider)</code>
<div class="block">Constructs a field cloner that copies objects by reading and writing the internal fields directly.</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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/cloning/FieldCloner.html#canClone(java.lang.Object)">canClone</a></strong>(java.lang.Object&nbsp;source)</code>
<div class="block">Determine whether or not the current cloner can clone the given object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/cloning/FieldCloner.html#clone(java.lang.Object)">clone</a></strong>(java.lang.Object&nbsp;source)</code>
<div class="block">Perform the clone.</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/cloning/FieldCloner.html#defaultTransform(com.comphenix.protocol.reflect.StructureModifier, com.comphenix.protocol.reflect.StructureModifier, com.comphenix.protocol.reflect.cloning.Cloner, int)">defaultTransform</a></strong>(<a href="../../../../../com/comphenix/protocol/reflect/StructureModifier.html" title="class in com.comphenix.protocol.reflect">StructureModifier</a>&lt;java.lang.Object&gt;&nbsp;modifierSource,
<a href="../../../../../com/comphenix/protocol/reflect/StructureModifier.html" title="class in com.comphenix.protocol.reflect">StructureModifier</a>&lt;java.lang.Object&gt;&nbsp;modifierDest,
<a href="../../../../../com/comphenix/protocol/reflect/cloning/Cloner.html" title="interface in com.comphenix.protocol.reflect.cloning">Cloner</a>&nbsp;defaultCloner,
int&nbsp;fieldIndex)</code>
<div class="block">Default implementation of the field transform.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/comphenix/protocol/reflect/cloning/Cloner.html" title="interface in com.comphenix.protocol.reflect.cloning">Cloner</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/cloning/FieldCloner.html#getDefaultCloner()">getDefaultCloner</a></strong>()</code>
<div class="block">Retrieve the default cloner used to clone the content of each field.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/reflect/cloning/FieldCloner.html#getInstanceProvider()">getInstanceProvider</a></strong>()</code>
<div class="block">Retrieve the instance provider this cloner is using to create new, empty classes.</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="defaultCloner">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultCloner</h4>
<pre>protected&nbsp;<a href="../../../../../com/comphenix/protocol/reflect/cloning/Cloner.html" title="interface in com.comphenix.protocol.reflect.cloning">Cloner</a> defaultCloner</pre>
</li>
</ul>
<a name="instanceProvider">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>instanceProvider</h4>
<pre>protected&nbsp;<a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a> instanceProvider</pre>
</li>
</ul>
<a name="writer">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>writer</h4>
<pre>protected&nbsp;<a href="../../../../../com/comphenix/protocol/reflect/ObjectWriter.html" title="class in com.comphenix.protocol.reflect">ObjectWriter</a> writer</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FieldCloner(com.comphenix.protocol.reflect.cloning.Cloner, com.comphenix.protocol.reflect.instances.InstanceProvider)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FieldCloner</h4>
<pre>public&nbsp;FieldCloner(<a href="../../../../../com/comphenix/protocol/reflect/cloning/Cloner.html" title="interface in com.comphenix.protocol.reflect.cloning">Cloner</a>&nbsp;defaultCloner,
<a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a>&nbsp;instanceProvider)</pre>
<div class="block">Constructs a field cloner that copies objects by reading and writing the internal fields directly.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultCloner</code> - - the default cloner used while copying fields.</dd><dd><code>instanceProvider</code> - - used to construct new, empty copies of a given type.</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="defaultTransform(com.comphenix.protocol.reflect.StructureModifier, com.comphenix.protocol.reflect.StructureModifier, com.comphenix.protocol.reflect.cloning.Cloner, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultTransform</h4>
<pre>protected&nbsp;void&nbsp;defaultTransform(<a href="../../../../../com/comphenix/protocol/reflect/StructureModifier.html" title="class in com.comphenix.protocol.reflect">StructureModifier</a>&lt;java.lang.Object&gt;&nbsp;modifierSource,
<a href="../../../../../com/comphenix/protocol/reflect/StructureModifier.html" title="class in com.comphenix.protocol.reflect">StructureModifier</a>&lt;java.lang.Object&gt;&nbsp;modifierDest,
<a href="../../../../../com/comphenix/protocol/reflect/cloning/Cloner.html" title="interface in com.comphenix.protocol.reflect.cloning">Cloner</a>&nbsp;defaultCloner,
int&nbsp;fieldIndex)</pre>
<div class="block">Default implementation of the field transform. Applies a clone operation before a field value is written.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>modifierSource</code> - - modifier for the original object.</dd><dd><code>modifierDest</code> - - modifier for the new cloned object.</dd><dd><code>defaultCloner</code> - - cloner to use.</dd><dd><code>fieldIndex</code> - - the current field index.</dd></dl>
</li>
</ul>
<a name="canClone(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canClone</h4>
<pre>public&nbsp;boolean&nbsp;canClone(java.lang.Object&nbsp;source)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../com/comphenix/protocol/reflect/cloning/Cloner.html#canClone(java.lang.Object)">Cloner</a></code></strong></div>
<div class="block">Determine whether or not the current cloner can clone the given object.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../com/comphenix/protocol/reflect/cloning/Cloner.html#canClone(java.lang.Object)">canClone</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/comphenix/protocol/reflect/cloning/Cloner.html" title="interface in com.comphenix.protocol.reflect.cloning">Cloner</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - - the object that is being considered.</dd>
<dt><span class="strong">Returns:</span></dt><dd>TRUE if this cloner can actually clone the given object, FALSE otherwise.</dd></dl>
</li>
</ul>
<a name="clone(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;java.lang.Object&nbsp;clone(java.lang.Object&nbsp;source)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../com/comphenix/protocol/reflect/cloning/Cloner.html#clone(java.lang.Object)">Cloner</a></code></strong></div>
<div class="block">Perform the clone.
<p>
This method should never be called unless a corresponding <a href="../../../../../com/comphenix/protocol/reflect/cloning/Cloner.html#canClone(java.lang.Object)"><code>Cloner.canClone(Object)</code></a> returns TRUE.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../com/comphenix/protocol/reflect/cloning/Cloner.html#clone(java.lang.Object)">clone</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/comphenix/protocol/reflect/cloning/Cloner.html" title="interface in com.comphenix.protocol.reflect.cloning">Cloner</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - - the value to clone.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A cloned value.</dd></dl>
</li>
</ul>
<a name="getDefaultCloner()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultCloner</h4>
<pre>public&nbsp;<a href="../../../../../com/comphenix/protocol/reflect/cloning/Cloner.html" title="interface in com.comphenix.protocol.reflect.cloning">Cloner</a>&nbsp;getDefaultCloner()</pre>
<div class="block">Retrieve the default cloner used to clone the content of each field.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Cloner used to clone fields.</dd></dl>
</li>
</ul>
<a name="getInstanceProvider()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getInstanceProvider</h4>
<pre>public&nbsp;<a href="../../../../../com/comphenix/protocol/reflect/instances/InstanceProvider.html" title="interface in com.comphenix.protocol.reflect.instances">InstanceProvider</a>&nbsp;getInstanceProvider()</pre>
<div class="block">Retrieve the instance provider this cloner is using to create new, empty classes.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The instance provider in use.</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/FieldCloner.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/cloning/CollectionCloner.html" title="class in com.comphenix.protocol.reflect.cloning"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../com/comphenix/protocol/reflect/cloning/ImmutableDetector.html" title="class in com.comphenix.protocol.reflect.cloning"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/comphenix/protocol/reflect/cloning/FieldCloner.html" target="_top">Frames</a></li>
<li><a href="FieldCloner.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>
In neuem Issue referenzieren Permalink kopieren