[Oorexx-svn] SF.net SVN: oorexx:[6708] docs/trunk/rexxref/collclasses.xml

[<bi...@us...>]

Revision: 6708
          http://oorexx.svn.sourceforge.net/oorexx/?rev=6708&view=rev
Author:   bigrixx
Date:     2011-02-06 13:10:33 +0000 (Sun, 06 Feb 2011)

Log Message:
-----------
[ oorexx-Feature Requests-2100054 ] Add a removeAll method to relation class.

Modified Paths:
--------------
    docs/trunk/rexxref/collclasses.xml

Modified: docs/trunk/rexxref/collclasses.xml
===================================================================
--- docs/trunk/rexxref/collclasses.xml	2011-02-06 13:09:37 UTC (rev 6707)
+++ docs/trunk/rexxref/collclasses.xml	2011-02-06 13:10:33 UTC (rev 6708)
@@ -1796,6 +1796,7 @@
 <member><link linkend="mthRelationPut">put</link></member>
 <member><link linkend="mthRelationPutSet">[ ]=</link></member>
 <member><link linkend="mthRelationRemove">remove</link></member>
+<member><link linkend="mthRelationRemoveAll">removeAll</link></member>
 <member><link linkend="mthRelationRemoveItem">removeItem</link></member>
 <member><link linkend="mthRelationSubset">subset</link></member>
 <member><link linkend="mthRelationSupplier">supplier</link></member>
@@ -4867,6 +4868,27 @@
 </para>
 </section>
 
+<section id="mthRelationRemoveAll"><title>removeAll</title>
+<indexterm><primary>removeAll method</primary>
+<secondary>of Relation class</secondary></indexterm>
+<indexterm><primary>method</primary>
+<secondary>removeAll method</secondary>
+<tertiary>of Relation class</tertiary></indexterm>
+<programlisting>
+<![CDATA[
+>>-removeAll(index)-----------------------------------------------><
+]]>
+</programlisting>
+
+<para>Returns and removes from a relation all member items with index
+<emphasis role="italic">index</emphasis>.  All removed items are returned
+in an array containing each of the removed items.  The order of the returned items
+is unspecified.  If no items have the specified index, an empty array is returned.
+Index equality is determined by
+using the == method of <emphasis role="italic">index</emphasis>.
+</para>
+</section>
+
 <section id="mthRelationRemoveItem"><title>removeItem</title>
 <indexterm><primary>removeItem method</primary>
 <secondary>of Relation class</secondary></indexterm>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.