src/share/classes/java/lang/Runtime.java

Print this page
rev 7588 : 8019862: Fix doclint errors in java.lang.*.
Summary: Fix doclint errors in java.lang.*
Reviewed-by: darcy
Contributed-by: Brian Burkhalter <brian.burkhalter@oracle.com>


 644      *          available for future allocated objects, measured in bytes.
 645      */
 646     public native long freeMemory();
 647 
 648     /**
 649      * Returns the total amount of memory in the Java virtual machine.
 650      * The value returned by this method may vary over time, depending on
 651      * the host environment.
 652      * <p>
 653      * Note that the amount of memory required to hold an object of any
 654      * given type may be implementation-dependent.
 655      *
 656      * @return  the total amount of memory currently available for current
 657      *          and future objects, measured in bytes.
 658      */
 659     public native long totalMemory();
 660 
 661     /**
 662      * Returns the maximum amount of memory that the Java virtual machine will
 663      * attempt to use.  If there is no inherent limit then the value {@link
 664      * java.lang.Long#MAX_VALUE} will be returned. </p>
 665      *
 666      * @return  the maximum amount of memory that the virtual machine will
 667      *          attempt to use, measured in bytes
 668      * @since 1.4
 669      */
 670     public native long maxMemory();
 671 
 672     /**
 673      * Runs the garbage collector.
 674      * Calling this method suggests that the Java virtual machine expend
 675      * effort toward recycling unused objects in order to make the memory
 676      * they currently occupy available for quick reuse. When control
 677      * returns from the method call, the virtual machine has made
 678      * its best effort to recycle all discarded objects.
 679      * <p>
 680      * The name <code>gc</code> stands for "garbage
 681      * collector". The virtual machine performs this recycling
 682      * process automatically as needed, in a separate thread, even if the
 683      * <code>gc</code> method is not invoked explicitly.
 684      * <p>




 644      *          available for future allocated objects, measured in bytes.
 645      */
 646     public native long freeMemory();
 647 
 648     /**
 649      * Returns the total amount of memory in the Java virtual machine.
 650      * The value returned by this method may vary over time, depending on
 651      * the host environment.
 652      * <p>
 653      * Note that the amount of memory required to hold an object of any
 654      * given type may be implementation-dependent.
 655      *
 656      * @return  the total amount of memory currently available for current
 657      *          and future objects, measured in bytes.
 658      */
 659     public native long totalMemory();
 660 
 661     /**
 662      * Returns the maximum amount of memory that the Java virtual machine will
 663      * attempt to use.  If there is no inherent limit then the value {@link
 664      * java.lang.Long#MAX_VALUE} will be returned.
 665      *
 666      * @return  the maximum amount of memory that the virtual machine will
 667      *          attempt to use, measured in bytes
 668      * @since 1.4
 669      */
 670     public native long maxMemory();
 671 
 672     /**
 673      * Runs the garbage collector.
 674      * Calling this method suggests that the Java virtual machine expend
 675      * effort toward recycling unused objects in order to make the memory
 676      * they currently occupy available for quick reuse. When control
 677      * returns from the method call, the virtual machine has made
 678      * its best effort to recycle all discarded objects.
 679      * <p>
 680      * The name <code>gc</code> stands for "garbage
 681      * collector". The virtual machine performs this recycling
 682      * process automatically as needed, in a separate thread, even if the
 683      * <code>gc</code> method is not invoked explicitly.
 684      * <p>