File	Doc	Category	Size	Date	Package
MemoryUsage.java	API Doc	Java SE 5 API	9842	Fri Aug 26 14:57:06 BST 2005	java.lang.management

MemoryUsage

• java.lang.Object

+----------------------------------------------+
+//////////////// | +
+//////////////// | +
+----------------------------------------------+

|--------|
init
|---------------|
used
|---------------------------|
committed
|----------------------------------------------|
max

Fields Summary
private final long	init
private final long	used
private final long	committed
private final long	max

Constructors Summary
public MemoryUsage(long init, long used, long committed, long max) Constructs a MemoryUsage object. param init the initial amount of memory in bytes that the Java virtual machine allocates; or -1 if undefined. param used the amount of used memory in bytes. param committed the amount of committed memory in bytes. param max the maximum amount of memory in bytes that can be used; or -1 if undefined. throws IllegalArgumentException if the value of init or max is negative but not -1; or the value of used or committed is negative; or used is greater than the value of committed; or committed is greater than the value of max max if defined. if (init < -1) { throw new IllegalArgumentException( "init parameter = " + init + " is negative but not -1."); } if (max < -1) { throw new IllegalArgumentException( "max parameter = " + max + " is negative but not -1."); } if (used < 0) { throw new IllegalArgumentException( "used parameter = " + used + " is negative."); } if (committed < 0) { throw new IllegalArgumentException( "committed parameter = " + committed + " is negative."); } if (used > committed) { throw new IllegalArgumentException( "used = " + used + " should be <= committed = " + committed); } if (max >= 0 && committed > max) { throw new IllegalArgumentException( "committed = " + committed + " should be < max = " + max); } this.init = init; this.used = used; this.committed = committed; this.max = max;
private MemoryUsage(CompositeData cd) Constructs a MemoryUsage object from a {@link CompositeData CompositeData}. // validate the input composite data MemoryUsageCompositeData.validateCompositeData(cd); this.init = MemoryUsageCompositeData.getInit(cd); this.used = MemoryUsageCompositeData.getUsed(cd); this.committed = MemoryUsageCompositeData.getCommitted(cd); this.max = MemoryUsageCompositeData.getMax(cd);

Methods Summary
public static java.lang.management.MemoryUsage	from(javax.management.openmbean.CompositeData cd) Returns a MemoryUsage object represented by the given CompositeData. The given CompositeData must contain the following attributes: Attribute Name Type init java.lang.Long used java.lang.Long committed java.lang.Long max java.lang.Long param cd CompositeData representing a MemoryUsage throws IllegalArgumentException if cd does not represent a MemoryUsage with the attributes described above. return a MemoryUsage object represented by cd if cd is not null; null otherwise. if (cd == null) { return null; } if (cd instanceof MemoryUsageCompositeData) { return ((MemoryUsageCompositeData) cd).getMemoryUsage(); } else { return new MemoryUsage(cd); }
public long	getCommitted() Returns the amount of memory in bytes that is committed for the Java virtual machine to use. This amount of memory is guaranteed for the Java virtual machine to use. return the amount of committed memory in bytes. return committed;
public long	getInit() Returns the amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management. This method returns -1 if the initial memory size is undefined. return the initial size of memory in bytes; -1 if undefined. return init;
public long	getMax() Returns the maximum amount of memory in bytes that can be used for memory management. This method returns -1 if the maximum memory size is undefined. This amount of memory is not guaranteed to be available for memory management if it is greater than the amount of committed memory. The Java virtual machine may fail to allocate memory even if the amount of used memory does not exceed this maximum size. return the maximum amount of memory in bytes; -1 if undefined. return max;
public long	getUsed() Returns the amount of used memory in bytes. return the amount of used memory in bytes. return used;
public java.lang.String	toString() Returns a descriptive representation of this memory usage. StringBuffer buf = new StringBuffer(); buf.append("init = " + init + "(" + (init >> 10) + "K) "); buf.append("used = " + used + "(" + (used >> 10) + "K) "); buf.append("committed = " + committed + "(" + (committed >> 10) + "K) " ); buf.append("max = " + max + "(" + (max >> 10) + "K)"); return buf.toString();