[Oorexx-svn] SF.net SVN: oorexx:[3901] docs/trunk/rexxref

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

Revision: 3901
          http://oorexx.svn.sourceforge.net/oorexx/?rev=3901&view=rev
Author:   bigrixx
Date:     2009-01-11 15:22:26 +0000 (Sun, 11 Jan 2009)

Log Message:
-----------
Add WeakReference class

Modified Paths:
--------------
    docs/trunk/rexxref/classes.sgml
    docs/trunk/rexxref/utilityclasses.sgml

Added Paths:
-----------
    docs/trunk/rexxref/ooRexxWeakReferenceClass.odg
    docs/trunk/rexxref/ooRexxWeakReferenceClass.png

Modified: docs/trunk/rexxref/classes.sgml
===================================================================
--- docs/trunk/rexxref/classes.sgml	2009-01-11 00:47:43 UTC (rev 3900)
+++ docs/trunk/rexxref/classes.sgml	2009-01-11 15:22:26 UTC (rev 3901)
@@ -94,7 +94,8 @@
 the <link linkend="clsRexxQueue">RexxQueue class</link>,
 the <link linkend="clsStreamSupplier">StreamSupplier class</link>,
 the <link linkend="clsSupplier">Supplier class</link>,
-and the <link linkend="clsTimeSpan">TimeSpan class</link>.</para>
+the <link linkend="clsTimeSpan">TimeSpan class</link>
+and the <link linkend="clsTimeSpan">WeakReference class</link>.</para>
 </listitem></varlistentry>
 <varlistentry><term>
 <link linkend="winclasses">Windows Classes</link></term>

Added: docs/trunk/rexxref/ooRexxWeakReferenceClass.odg
===================================================================
(Binary files differ)


Property changes on: docs/trunk/rexxref/ooRexxWeakReferenceClass.odg
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Added: docs/trunk/rexxref/ooRexxWeakReferenceClass.png
===================================================================
(Binary files differ)


Property changes on: docs/trunk/rexxref/ooRexxWeakReferenceClass.png
___________________________________________________________________
Added: svn:mime-type
   + image/png

Modified: docs/trunk/rexxref/utilityclasses.sgml
===================================================================
--- docs/trunk/rexxref/utilityclasses.sgml	2009-01-11 00:47:43 UTC (rev 3900)
+++ docs/trunk/rexxref/utilityclasses.sgml	2009-01-11 15:22:26 UTC (rev 3901)
@@ -5646,5 +5646,68 @@
 </section>
 </section>
 
+<section id="clsWeakReference"><title>The WeakReference Class</title>
+<indexterm><primary>WeakReference class</primary></indexterm>
+<indexterm><primary>class</primary>
+<secondary>WeakReference class</secondary></indexterm>
+<figure><title>The WeakReference class and methods</title>
+<mediaobject>
+<imageobject>
+<!-- Note! - if we include a /imagedata tag we get an error for DSSSL! -->
+<imagedata fileref="ooRexxWeakReferenceClass.png" align="left">
+</imageobject>
+</mediaobject>
+</figure>
+<para>A WeakReference instance maintains a non-pinning reference to another
+object.  A non-pinning reference does not prevent an object from getting garbage
+collected or having its uninit method run when there are no longer normal
+references maintained to the object.  Once the referenced object is eligible for
+garbage collection, the reference inside the WeakReference instance will be
+cleared and the VALUE method will return .nil on all subsequent calls.
+WeakReferences are useful for maintaining caches of objects without preventing
+the objects from being reclaimed by the garbage collector when needed.
+<note><title>Note</title>
+<para>The WeakReference class also has available class methods that its
+metaclass, the <link linkend="clsClass">Class class</link>, defines.</para></note>
+
+<section><title>Inherited Methods</title>
+
+&objclsmthods;
+
 </section>
 
+<section id="mthWeakReferenceNew"><title>new (Class Method)</title>
+<indexterm><primary>new method</primary>
+<secondary>of WeakReference class</secondary></indexterm>
+<indexterm><primary>method</primary>
+<secondary>new method</secondary>
+<tertiary>of WeakReference class</tertiary></indexterm>
+<programlisting>
+<![CDATA[
+>>-new-(object)  -------+--------------------------------------><
+]]>
+</programlisting>
+
+<para>Returns a new WeakReference instance containing a reference to
+<emphasis role="italic">object</emphasis>.<para>
+</section>
+
+<section id="mthWeakReferenceValue"><title>value</title>
+<indexterm><primary>value method</primary>
+<secondary>of WeakReference class</secondary></indexterm>
+<indexterm><primary>method</primary>
+<secondary>value method</secondary>
+<tertiary>of WeakReference class</tertiary></indexterm>
+<programlisting>
+<![CDATA[
+>>-value------------------------------------------------><
+]]>
+</programlisting>
+<para>This method returns the referenced object.  If the object has been garbage
+collected, then .nil is returned.
+</para>
+</section>
+</section>
+
+</section>
+


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