rt/emul/mini/src/main/java/java/lang/Object.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Tue, 17 Sep 2013 14:25:30 +0200
changeset 1285 456e2909bd5a
parent 1260 fe3567c7b522
child 1458 5c8caf0ba8b8
child 1483 cecf27be3802
permissions -rw-r--r--
#5368: Provide some implementation of wait and notify
     1 /*
     2  * Copyright (c) 1994, 2010, Oracle and/or its affiliates. All rights reserved.
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4  *
     5  * This code is free software; you can redistribute it and/or modify it
     6  * under the terms of the GNU General Public License version 2 only, as
     7  * published by the Free Software Foundation.  Oracle designates this
     8  * particular file as subject to the "Classpath" exception as provided
     9  * by Oracle in the LICENSE file that accompanied this code.
    10  *
    11  * This code is distributed in the hope that it will be useful, but WITHOUT
    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    14  * version 2 for more details (a copy is included in the LICENSE file that
    15  * accompanied this code).
    16  *
    17  * You should have received a copy of the GNU General Public License version
    18  * 2 along with this work; if not, write to the Free Software Foundation,
    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    20  *
    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    22  * or visit www.oracle.com if you need additional information or have any
    23  * questions.
    24  */
    25 
    26 package java.lang;
    27 
    28 import java.lang.reflect.Array;
    29 import org.apidesign.bck2brwsr.core.JavaScriptBody;
    30 import org.apidesign.bck2brwsr.core.JavaScriptPrototype;
    31 
    32 /**
    33  * Class {@code Object} is the root of the class hierarchy.
    34  * Every class has {@code Object} as a superclass. All objects,
    35  * including arrays, implement the methods of this class.
    36  *
    37  * @author  unascribed
    38  * @see     java.lang.Class
    39  * @since   JDK1.0
    40  */
    41 @JavaScriptPrototype(container = "Object.prototype", prototype = "new Object")
    42 public class Object {
    43 
    44     private static void registerNatives() {
    45         boolean assertsOn = false;
    46         assert assertsOn = false;
    47         if (assertsOn) try {
    48             Array.get(null, 0);
    49         } catch (Throwable ex) {
    50             // ignore
    51         }
    52     }
    53     @JavaScriptBody(args = {}, body = "var p = vm.java_lang_Object(false);" +
    54         "p.toString = function() { return this.toString__Ljava_lang_String_2(); };"
    55     )
    56     private static native void registerToString();
    57     static {
    58         registerNatives();
    59         registerToString();
    60     }
    61 
    62     /**
    63      * Returns the runtime class of this {@code Object}. The returned
    64      * {@code Class} object is the object that is locked by {@code
    65      * static synchronized} methods of the represented class.
    66      *
    67      * <p><b>The actual result type is {@code Class<? extends |X|>}
    68      * where {@code |X|} is the erasure of the static type of the
    69      * expression on which {@code getClass} is called.</b> For
    70      * example, no cast is required in this code fragment:</p>
    71      *
    72      * <p>
    73      * {@code Number n = 0;                             }<br>
    74      * {@code Class<? extends Number> c = n.getClass(); }
    75      * </p>
    76      *
    77      * @return The {@code Class} object that represents the runtime
    78      *         class of this object.
    79      * @see    Class Literals, section 15.8.2 of
    80      *         <cite>The Java&trade; Language Specification</cite>.
    81      */
    82     public final Class<?> getClass() {
    83         Class<?> c = getClassImpl();
    84         return c == null ? Object.class : c;
    85     }
    86 
    87     @JavaScriptBody(args={}, body=
    88           "var c = this.constructor.$class;\n"
    89         + "return c ? c : null;\n"
    90     )
    91     private final native Class<?> getClassImpl();
    92     
    93     /**
    94      * Returns a hash code value for the object. This method is
    95      * supported for the benefit of hash tables such as those provided by
    96      * {@link java.util.HashMap}.
    97      * <p>
    98      * The general contract of {@code hashCode} is:
    99      * <ul>
   100      * <li>Whenever it is invoked on the same object more than once during
   101      *     an execution of a Java application, the {@code hashCode} method
   102      *     must consistently return the same integer, provided no information
   103      *     used in {@code equals} comparisons on the object is modified.
   104      *     This integer need not remain consistent from one execution of an
   105      *     application to another execution of the same application.
   106      * <li>If two objects are equal according to the {@code equals(Object)}
   107      *     method, then calling the {@code hashCode} method on each of
   108      *     the two objects must produce the same integer result.
   109      * <li>It is <em>not</em> required that if two objects are unequal
   110      *     according to the {@link java.lang.Object#equals(java.lang.Object)}
   111      *     method, then calling the {@code hashCode} method on each of the
   112      *     two objects must produce distinct integer results.  However, the
   113      *     programmer should be aware that producing distinct integer results
   114      *     for unequal objects may improve the performance of hash tables.
   115      * </ul>
   116      * <p>
   117      * As much as is reasonably practical, the hashCode method defined by
   118      * class {@code Object} does return distinct integers for distinct
   119      * objects. (This is typically implemented by converting the internal
   120      * address of the object into an integer, but this implementation
   121      * technique is not required by the
   122      * Java<font size="-2"><sup>TM</sup></font> programming language.)
   123      *
   124      * @return  a hash code value for this object.
   125      * @see     java.lang.Object#equals(java.lang.Object)
   126      * @see     java.lang.System#identityHashCode
   127      */
   128     public int hashCode() {
   129         return defaultHashCode();
   130     }
   131     @JavaScriptBody(args = {}, body = 
   132         "if (this.$hashCode) return this.$hashCode;\n"
   133         + "var h = this.computeHashCode__I();\n"
   134         + "return this.$hashCode = h & h;"
   135     )
   136     final native int defaultHashCode();
   137 
   138     @JavaScriptBody(args = {}, body = "return Math.random() * Math.pow(2, 32);")
   139     native int computeHashCode();
   140     
   141     /**
   142      * Indicates whether some other object is "equal to" this one.
   143      * <p>
   144      * The {@code equals} method implements an equivalence relation
   145      * on non-null object references:
   146      * <ul>
   147      * <li>It is <i>reflexive</i>: for any non-null reference value
   148      *     {@code x}, {@code x.equals(x)} should return
   149      *     {@code true}.
   150      * <li>It is <i>symmetric</i>: for any non-null reference values
   151      *     {@code x} and {@code y}, {@code x.equals(y)}
   152      *     should return {@code true} if and only if
   153      *     {@code y.equals(x)} returns {@code true}.
   154      * <li>It is <i>transitive</i>: for any non-null reference values
   155      *     {@code x}, {@code y}, and {@code z}, if
   156      *     {@code x.equals(y)} returns {@code true} and
   157      *     {@code y.equals(z)} returns {@code true}, then
   158      *     {@code x.equals(z)} should return {@code true}.
   159      * <li>It is <i>consistent</i>: for any non-null reference values
   160      *     {@code x} and {@code y}, multiple invocations of
   161      *     {@code x.equals(y)} consistently return {@code true}
   162      *     or consistently return {@code false}, provided no
   163      *     information used in {@code equals} comparisons on the
   164      *     objects is modified.
   165      * <li>For any non-null reference value {@code x},
   166      *     {@code x.equals(null)} should return {@code false}.
   167      * </ul>
   168      * <p>
   169      * The {@code equals} method for class {@code Object} implements
   170      * the most discriminating possible equivalence relation on objects;
   171      * that is, for any non-null reference values {@code x} and
   172      * {@code y}, this method returns {@code true} if and only
   173      * if {@code x} and {@code y} refer to the same object
   174      * ({@code x == y} has the value {@code true}).
   175      * <p>
   176      * Note that it is generally necessary to override the {@code hashCode}
   177      * method whenever this method is overridden, so as to maintain the
   178      * general contract for the {@code hashCode} method, which states
   179      * that equal objects must have equal hash codes.
   180      *
   181      * @param   obj   the reference object with which to compare.
   182      * @return  {@code true} if this object is the same as the obj
   183      *          argument; {@code false} otherwise.
   184      * @see     #hashCode()
   185      * @see     java.util.HashMap
   186      */
   187     public boolean equals(Object obj) {
   188         return (this == obj);
   189     }
   190 
   191     /**
   192      * Creates and returns a copy of this object.  The precise meaning
   193      * of "copy" may depend on the class of the object. The general
   194      * intent is that, for any object {@code x}, the expression:
   195      * <blockquote>
   196      * <pre>
   197      * x.clone() != x</pre></blockquote>
   198      * will be true, and that the expression:
   199      * <blockquote>
   200      * <pre>
   201      * x.clone().getClass() == x.getClass()</pre></blockquote>
   202      * will be {@code true}, but these are not absolute requirements.
   203      * While it is typically the case that:
   204      * <blockquote>
   205      * <pre>
   206      * x.clone().equals(x)</pre></blockquote>
   207      * will be {@code true}, this is not an absolute requirement.
   208      * <p>
   209      * By convention, the returned object should be obtained by calling
   210      * {@code super.clone}.  If a class and all of its superclasses (except
   211      * {@code Object}) obey this convention, it will be the case that
   212      * {@code x.clone().getClass() == x.getClass()}.
   213      * <p>
   214      * By convention, the object returned by this method should be independent
   215      * of this object (which is being cloned).  To achieve this independence,
   216      * it may be necessary to modify one or more fields of the object returned
   217      * by {@code super.clone} before returning it.  Typically, this means
   218      * copying any mutable objects that comprise the internal "deep structure"
   219      * of the object being cloned and replacing the references to these
   220      * objects with references to the copies.  If a class contains only
   221      * primitive fields or references to immutable objects, then it is usually
   222      * the case that no fields in the object returned by {@code super.clone}
   223      * need to be modified.
   224      * <p>
   225      * The method {@code clone} for class {@code Object} performs a
   226      * specific cloning operation. First, if the class of this object does
   227      * not implement the interface {@code Cloneable}, then a
   228      * {@code CloneNotSupportedException} is thrown. Note that all arrays
   229      * are considered to implement the interface {@code Cloneable} and that
   230      * the return type of the {@code clone} method of an array type {@code T[]}
   231      * is {@code T[]} where T is any reference or primitive type.
   232      * Otherwise, this method creates a new instance of the class of this
   233      * object and initializes all its fields with exactly the contents of
   234      * the corresponding fields of this object, as if by assignment; the
   235      * contents of the fields are not themselves cloned. Thus, this method
   236      * performs a "shallow copy" of this object, not a "deep copy" operation.
   237      * <p>
   238      * The class {@code Object} does not itself implement the interface
   239      * {@code Cloneable}, so calling the {@code clone} method on an object
   240      * whose class is {@code Object} will result in throwing an
   241      * exception at run time.
   242      *
   243      * @return     a clone of this instance.
   244      * @exception  CloneNotSupportedException  if the object's class does not
   245      *               support the {@code Cloneable} interface. Subclasses
   246      *               that override the {@code clone} method can also
   247      *               throw this exception to indicate that an instance cannot
   248      *               be cloned.
   249      * @see java.lang.Cloneable
   250      */
   251     protected Object clone() throws CloneNotSupportedException {
   252         Object ret = clone(this);
   253         if (ret == null) {
   254             throw new CloneNotSupportedException(getClass().getName());
   255         }
   256         return ret;
   257     }
   258 
   259     @JavaScriptBody(args = "self", body = 
   260           "\nif (!self.$instOf_java_lang_Cloneable) {"
   261         + "\n  return null;"
   262         + "\n} else {"
   263         + "\n  var clone = self.constructor(true);"
   264         + "\n  var props = Object.getOwnPropertyNames(self);"
   265         + "\n  for (var i = 0; i < props.length; i++) {"
   266         + "\n    var p = props[i];"
   267         + "\n    clone[p] = self[p];"
   268         + "\n  };"
   269         + "\n  return clone;"
   270         + "\n}"
   271     )
   272     private static native Object clone(Object self) throws CloneNotSupportedException;
   273 
   274     /**
   275      * Returns a string representation of the object. In general, the
   276      * {@code toString} method returns a string that
   277      * "textually represents" this object. The result should
   278      * be a concise but informative representation that is easy for a
   279      * person to read.
   280      * It is recommended that all subclasses override this method.
   281      * <p>
   282      * The {@code toString} method for class {@code Object}
   283      * returns a string consisting of the name of the class of which the
   284      * object is an instance, the at-sign character `{@code @}', and
   285      * the unsigned hexadecimal representation of the hash code of the
   286      * object. In other words, this method returns a string equal to the
   287      * value of:
   288      * <blockquote>
   289      * <pre>
   290      * getClass().getName() + '@' + Integer.toHexString(hashCode())
   291      * </pre></blockquote>
   292      *
   293      * @return  a string representation of the object.
   294      */
   295     public String toString() {
   296         return getClass().getName() + "@" + Integer.toHexString(hashCode());
   297     }
   298 
   299     /**
   300      * Wakes up a single thread that is waiting on this object's
   301      * monitor. If any threads are waiting on this object, one of them
   302      * is chosen to be awakened. The choice is arbitrary and occurs at
   303      * the discretion of the implementation. A thread waits on an object's
   304      * monitor by calling one of the {@code wait} methods.
   305      * <p>
   306      * The awakened thread will not be able to proceed until the current
   307      * thread relinquishes the lock on this object. The awakened thread will
   308      * compete in the usual manner with any other threads that might be
   309      * actively competing to synchronize on this object; for example, the
   310      * awakened thread enjoys no reliable privilege or disadvantage in being
   311      * the next thread to lock this object.
   312      * <p>
   313      * This method should only be called by a thread that is the owner
   314      * of this object's monitor. A thread becomes the owner of the
   315      * object's monitor in one of three ways:
   316      * <ul>
   317      * <li>By executing a synchronized instance method of that object.
   318      * <li>By executing the body of a {@code synchronized} statement
   319      *     that synchronizes on the object.
   320      * <li>For objects of type {@code Class,} by executing a
   321      *     synchronized static method of that class.
   322      * </ul>
   323      * <p>
   324      * Only one thread at a time can own an object's monitor.
   325      *
   326      * @exception  IllegalMonitorStateException  if the current thread is not
   327      *               the owner of this object's monitor.
   328      * @see        java.lang.Object#notifyAll()
   329      * @see        java.lang.Object#wait()
   330      */
   331     public final void notify() {
   332     }
   333 
   334     /**
   335      * Wakes up all threads that are waiting on this object's monitor. A
   336      * thread waits on an object's monitor by calling one of the
   337      * {@code wait} methods.
   338      * <p>
   339      * The awakened threads will not be able to proceed until the current
   340      * thread relinquishes the lock on this object. The awakened threads
   341      * will compete in the usual manner with any other threads that might
   342      * be actively competing to synchronize on this object; for example,
   343      * the awakened threads enjoy no reliable privilege or disadvantage in
   344      * being the next thread to lock this object.
   345      * <p>
   346      * This method should only be called by a thread that is the owner
   347      * of this object's monitor. See the {@code notify} method for a
   348      * description of the ways in which a thread can become the owner of
   349      * a monitor.
   350      *
   351      * @exception  IllegalMonitorStateException  if the current thread is not
   352      *               the owner of this object's monitor.
   353      * @see        java.lang.Object#notify()
   354      * @see        java.lang.Object#wait()
   355      */
   356     public final void notifyAll() {
   357     }
   358 
   359     /**
   360      * Causes the current thread to wait until either another thread invokes the
   361      * {@link java.lang.Object#notify()} method or the
   362      * {@link java.lang.Object#notifyAll()} method for this object, or a
   363      * specified amount of time has elapsed.
   364      * <p>
   365      * The current thread must own this object's monitor.
   366      * <p>
   367      * This method causes the current thread (call it <var>T</var>) to
   368      * place itself in the wait set for this object and then to relinquish
   369      * any and all synchronization claims on this object. Thread <var>T</var>
   370      * becomes disabled for thread scheduling purposes and lies dormant
   371      * until one of four things happens:
   372      * <ul>
   373      * <li>Some other thread invokes the {@code notify} method for this
   374      * object and thread <var>T</var> happens to be arbitrarily chosen as
   375      * the thread to be awakened.
   376      * <li>Some other thread invokes the {@code notifyAll} method for this
   377      * object.
   378      * <li>Some other thread {@linkplain Thread#interrupt() interrupts}
   379      * thread <var>T</var>.
   380      * <li>The specified amount of real time has elapsed, more or less.  If
   381      * {@code timeout} is zero, however, then real time is not taken into
   382      * consideration and the thread simply waits until notified.
   383      * </ul>
   384      * The thread <var>T</var> is then removed from the wait set for this
   385      * object and re-enabled for thread scheduling. It then competes in the
   386      * usual manner with other threads for the right to synchronize on the
   387      * object; once it has gained control of the object, all its
   388      * synchronization claims on the object are restored to the status quo
   389      * ante - that is, to the situation as of the time that the {@code wait}
   390      * method was invoked. Thread <var>T</var> then returns from the
   391      * invocation of the {@code wait} method. Thus, on return from the
   392      * {@code wait} method, the synchronization state of the object and of
   393      * thread {@code T} is exactly as it was when the {@code wait} method
   394      * was invoked.
   395      * <p>
   396      * A thread can also wake up without being notified, interrupted, or
   397      * timing out, a so-called <i>spurious wakeup</i>.  While this will rarely
   398      * occur in practice, applications must guard against it by testing for
   399      * the condition that should have caused the thread to be awakened, and
   400      * continuing to wait if the condition is not satisfied.  In other words,
   401      * waits should always occur in loops, like this one:
   402      * <pre>
   403      *     synchronized (obj) {
   404      *         while (&lt;condition does not hold&gt;)
   405      *             obj.wait(timeout);
   406      *         ... // Perform action appropriate to condition
   407      *     }
   408      * </pre>
   409      * (For more information on this topic, see Section 3.2.3 in Doug Lea's
   410      * "Concurrent Programming in Java (Second Edition)" (Addison-Wesley,
   411      * 2000), or Item 50 in Joshua Bloch's "Effective Java Programming
   412      * Language Guide" (Addison-Wesley, 2001).
   413      *
   414      * <p>If the current thread is {@linkplain java.lang.Thread#interrupt()
   415      * interrupted} by any thread before or while it is waiting, then an
   416      * {@code InterruptedException} is thrown.  This exception is not
   417      * thrown until the lock status of this object has been restored as
   418      * described above.
   419      *
   420      * <p>
   421      * Note that the {@code wait} method, as it places the current thread
   422      * into the wait set for this object, unlocks only this object; any
   423      * other objects on which the current thread may be synchronized remain
   424      * locked while the thread waits.
   425      * <p>
   426      * This method should only be called by a thread that is the owner
   427      * of this object's monitor. See the {@code notify} method for a
   428      * description of the ways in which a thread can become the owner of
   429      * a monitor.
   430      *
   431      * @param      timeout   the maximum time to wait in milliseconds.
   432      * @exception  IllegalArgumentException      if the value of timeout is
   433      *               negative.
   434      * @exception  IllegalMonitorStateException  if the current thread is not
   435      *               the owner of the object's monitor.
   436      * @exception  InterruptedException if any thread interrupted the
   437      *             current thread before or while the current thread
   438      *             was waiting for a notification.  The <i>interrupted
   439      *             status</i> of the current thread is cleared when
   440      *             this exception is thrown.
   441      * @see        java.lang.Object#notify()
   442      * @see        java.lang.Object#notifyAll()
   443      */
   444     public final void wait(long timeout) throws InterruptedException {
   445         throw new InterruptedException();
   446     }
   447 
   448     /**
   449      * Causes the current thread to wait until another thread invokes the
   450      * {@link java.lang.Object#notify()} method or the
   451      * {@link java.lang.Object#notifyAll()} method for this object, or
   452      * some other thread interrupts the current thread, or a certain
   453      * amount of real time has elapsed.
   454      * <p>
   455      * This method is similar to the {@code wait} method of one
   456      * argument, but it allows finer control over the amount of time to
   457      * wait for a notification before giving up. The amount of real time,
   458      * measured in nanoseconds, is given by:
   459      * <blockquote>
   460      * <pre>
   461      * 1000000*timeout+nanos</pre></blockquote>
   462      * <p>
   463      * In all other respects, this method does the same thing as the
   464      * method {@link #wait(long)} of one argument. In particular,
   465      * {@code wait(0, 0)} means the same thing as {@code wait(0)}.
   466      * <p>
   467      * The current thread must own this object's monitor. The thread
   468      * releases ownership of this monitor and waits until either of the
   469      * following two conditions has occurred:
   470      * <ul>
   471      * <li>Another thread notifies threads waiting on this object's monitor
   472      *     to wake up either through a call to the {@code notify} method
   473      *     or the {@code notifyAll} method.
   474      * <li>The timeout period, specified by {@code timeout}
   475      *     milliseconds plus {@code nanos} nanoseconds arguments, has
   476      *     elapsed.
   477      * </ul>
   478      * <p>
   479      * The thread then waits until it can re-obtain ownership of the
   480      * monitor and resumes execution.
   481      * <p>
   482      * As in the one argument version, interrupts and spurious wakeups are
   483      * possible, and this method should always be used in a loop:
   484      * <pre>
   485      *     synchronized (obj) {
   486      *         while (&lt;condition does not hold&gt;)
   487      *             obj.wait(timeout, nanos);
   488      *         ... // Perform action appropriate to condition
   489      *     }
   490      * </pre>
   491      * This method should only be called by a thread that is the owner
   492      * of this object's monitor. See the {@code notify} method for a
   493      * description of the ways in which a thread can become the owner of
   494      * a monitor.
   495      *
   496      * @param      timeout   the maximum time to wait in milliseconds.
   497      * @param      nanos      additional time, in nanoseconds range
   498      *                       0-999999.
   499      * @exception  IllegalArgumentException      if the value of timeout is
   500      *                      negative or the value of nanos is
   501      *                      not in the range 0-999999.
   502      * @exception  IllegalMonitorStateException  if the current thread is not
   503      *               the owner of this object's monitor.
   504      * @exception  InterruptedException if any thread interrupted the
   505      *             current thread before or while the current thread
   506      *             was waiting for a notification.  The <i>interrupted
   507      *             status</i> of the current thread is cleared when
   508      *             this exception is thrown.
   509      */
   510     public final void wait(long timeout, int nanos) throws InterruptedException {
   511         throw new InterruptedException();
   512     }
   513 
   514     /**
   515      * Causes the current thread to wait until another thread invokes the
   516      * {@link java.lang.Object#notify()} method or the
   517      * {@link java.lang.Object#notifyAll()} method for this object.
   518      * In other words, this method behaves exactly as if it simply
   519      * performs the call {@code wait(0)}.
   520      * <p>
   521      * The current thread must own this object's monitor. The thread
   522      * releases ownership of this monitor and waits until another thread
   523      * notifies threads waiting on this object's monitor to wake up
   524      * either through a call to the {@code notify} method or the
   525      * {@code notifyAll} method. The thread then waits until it can
   526      * re-obtain ownership of the monitor and resumes execution.
   527      * <p>
   528      * As in the one argument version, interrupts and spurious wakeups are
   529      * possible, and this method should always be used in a loop:
   530      * <pre>
   531      *     synchronized (obj) {
   532      *         while (&lt;condition does not hold&gt;)
   533      *             obj.wait();
   534      *         ... // Perform action appropriate to condition
   535      *     }
   536      * </pre>
   537      * This method should only be called by a thread that is the owner
   538      * of this object's monitor. See the {@code notify} method for a
   539      * description of the ways in which a thread can become the owner of
   540      * a monitor.
   541      *
   542      * @exception  IllegalMonitorStateException  if the current thread is not
   543      *               the owner of the object's monitor.
   544      * @exception  InterruptedException if any thread interrupted the
   545      *             current thread before or while the current thread
   546      *             was waiting for a notification.  The <i>interrupted
   547      *             status</i> of the current thread is cleared when
   548      *             this exception is thrown.
   549      * @see        java.lang.Object#notify()
   550      * @see        java.lang.Object#notifyAll()
   551      */
   552     public final void wait() throws InterruptedException {
   553         throw new InterruptedException();
   554     }
   555 
   556     /**
   557      * Called by the garbage collector on an object when garbage collection
   558      * determines that there are no more references to the object.
   559      * A subclass overrides the {@code finalize} method to dispose of
   560      * system resources or to perform other cleanup.
   561      * <p>
   562      * The general contract of {@code finalize} is that it is invoked
   563      * if and when the Java<font size="-2"><sup>TM</sup></font> virtual
   564      * machine has determined that there is no longer any
   565      * means by which this object can be accessed by any thread that has
   566      * not yet died, except as a result of an action taken by the
   567      * finalization of some other object or class which is ready to be
   568      * finalized. The {@code finalize} method may take any action, including
   569      * making this object available again to other threads; the usual purpose
   570      * of {@code finalize}, however, is to perform cleanup actions before
   571      * the object is irrevocably discarded. For example, the finalize method
   572      * for an object that represents an input/output connection might perform
   573      * explicit I/O transactions to break the connection before the object is
   574      * permanently discarded.
   575      * <p>
   576      * The {@code finalize} method of class {@code Object} performs no
   577      * special action; it simply returns normally. Subclasses of
   578      * {@code Object} may override this definition.
   579      * <p>
   580      * The Java programming language does not guarantee which thread will
   581      * invoke the {@code finalize} method for any given object. It is
   582      * guaranteed, however, that the thread that invokes finalize will not
   583      * be holding any user-visible synchronization locks when finalize is
   584      * invoked. If an uncaught exception is thrown by the finalize method,
   585      * the exception is ignored and finalization of that object terminates.
   586      * <p>
   587      * After the {@code finalize} method has been invoked for an object, no
   588      * further action is taken until the Java virtual machine has again
   589      * determined that there is no longer any means by which this object can
   590      * be accessed by any thread that has not yet died, including possible
   591      * actions by other objects or classes which are ready to be finalized,
   592      * at which point the object may be discarded.
   593      * <p>
   594      * The {@code finalize} method is never invoked more than once by a Java
   595      * virtual machine for any given object.
   596      * <p>
   597      * Any exception thrown by the {@code finalize} method causes
   598      * the finalization of this object to be halted, but is otherwise
   599      * ignored.
   600      *
   601      * @throws Throwable the {@code Exception} raised by this method
   602      */
   603     protected void finalize() throws Throwable { }
   604 }