DeepCopy (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (tags) |
m (add note re exception to deep copyability) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Arraylist:DeepCopy subtitle}} | {{Template:Arraylist:DeepCopy subtitle}} | ||
<var>DeepCopy</var> makes a "deep copy" of the <var>Arraylist</var> method object, <var class="term">al</var>. If <var class="term">al</var> contains objects, they <b><i>are</i></b> copied. If <var class="term">al</var> is <var>Null</var>, a <var>Null</var> is returned. | |||
<var>DeepCopy</var> makes a "deep copy" of the <var>Arraylist</var> method object, <var class="term">al</var>. If <var class="term">al</var> contains objects, they <b><i>are</i></b> copied. If <var class="term">al</var> is Null, a Null is returned. | |||
==Syntax== | ==Syntax== | ||
{{Template:Arraylist:DeepCopy syntax}} | {{Template:Arraylist:DeepCopy syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%copyList</th> | <tr><th>%copyList</th> | ||
<td>An <var>Arraylist</var> to contain the deep copy of <var class="term">al</var>. </td></tr> | <td>An <var>Arraylist</var> to contain the deep copy of the method object, <var class="term">al</var>. </td></tr> | ||
<tr><th>al</th> | <tr><th>al</th> | ||
<td>An <var>Arraylist</var> object.</td></tr> | <td>An <var>Arraylist</var> object, which may be <var>Null</var>.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | |||
<ul> | |||
<li>Although <var>Arraylist</var> objects in general are deep copyable, a particular <var>Arraylist</var> might contain references to non-deep-copyable objects, which disallows deep copy of that specific <var>Arraylist</var>. </li> | |||
</ul> | |||
==See also== | ==See also== | ||
<ul><li>For more information about copyability, see [[Copying objects|"Copying objects"]].</ul> | <ul> | ||
<li>Contrast with <var>[[Copy_(Arraylist_function)|Copy]]</var> which <b><i>does not</i></b> copy any nested objects. | |||
<li>For more information about copyability, see [[Copying objects|"Copying objects"]]. | |||
</ul> | |||
{{Template:Arraylist:DeepCopy footer}} | {{Template:Arraylist:DeepCopy footer}} | ||
Latest revision as of 22:04, 23 January 2017
Deep Copy the Arraylist (Arraylist class)
DeepCopy makes a "deep copy" of the Arraylist method object, al. If al contains objects, they are copied. If al is Null, a Null is returned.
Syntax
%copyList = al:DeepCopy
Syntax terms
| %copyList | An Arraylist to contain the deep copy of the method object, al. |
|---|---|
| al | An Arraylist object, which may be Null. |
Usage notes
- Although Arraylist objects in general are deep copyable, a particular Arraylist might contain references to non-deep-copyable objects, which disallows deep copy of that specific Arraylist.
See also
- Contrast with Copy which does not copy any nested objects.
- For more information about copyability, see "Copying objects".