io.scif.util

Class MemoryTools

java.lang.Object

io.scif.util.MemoryTools

public class MemoryTools
extends Object

A utility class with convenience methods to obtain information about the heap.

Author:

Johannes Schindelin

Constructor Summary

Constructors

Constructor and Description
MemoryTools()

Method Summary

Modifier and Type	Method and Description
static long	totalAvailableMemory() Returns the total amount of remaining memory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MemoryTools

public MemoryTools()

Method Detail

totalAvailableMemory

public static long totalAvailableMemory()

Returns the total amount of remaining memory.

Slightly tricky: totalMemory() returns the amount of RAM claimed currently, not the maximum amount Java will claim when asked (that is maxMemory() instead). Likewise, freeMemory() returns the number of free bytes in the currently claimed chunk of RAM, not the number of bytes still available for Java.

Therefore, a little arithmetic is required to obtain the real number of available bytes for us to use.

Returns:

the amount of memory available for data