org.eclipse.mat.hprof.acquire
Class JMapHeapDumpProvider

java.lang.Object
  extended by org.eclipse.mat.hprof.acquire.JMapHeapDumpProvider
All Implemented Interfaces:
IHeapDumpProvider

public class JMapHeapDumpProvider
extends java.lang.Object
implements IHeapDumpProvider


Field Summary
 java.io.File jdkHome
           
 
Constructor Summary
JMapHeapDumpProvider()
           
 
Method Summary
 java.io.File acquireDump(VmInfo info, java.io.File preferredLocation, IProgressListener listener)
          Acquire a heap dump from a locally running Java process.
 java.util.List<JmapVmInfo> getAvailableVMs(IProgressListener listener)
          Returns a list of locally running Java processes from which the heap dump provider can attempt to acquire a heap dump
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

jdkHome

public java.io.File jdkHome
Constructor Detail

JMapHeapDumpProvider

public JMapHeapDumpProvider()
Method Detail

acquireDump

public java.io.File acquireDump(VmInfo info,
                                java.io.File preferredLocation,
                                IProgressListener listener)
                         throws SnapshotException
Description copied from interface: IHeapDumpProvider
Acquire a heap dump from a locally running Java process. The

Specified by:
acquireDump in interface IHeapDumpProvider
Parameters:
info - a descriptor of the Java process which should be dumped
preferredLocation - a preferred filename under which the heap dump should be saved. The IHeapDumpProvider is not obliged to provide the heap dump at this location
listener - a progress listener
Returns:
the File under which the successfully generated heap dump is saved
Throws:
SnapshotException

getAvailableVMs

public java.util.List<JmapVmInfo> getAvailableVMs(IProgressListener listener)
                                           throws SnapshotException
Description copied from interface: IHeapDumpProvider
Returns a list of locally running Java processes from which the heap dump provider can attempt to acquire a heap dump

Specified by:
getAvailableVMs in interface IHeapDumpProvider
Parameters:
listener - a progress listener
Returns:
List the list of processes (VmInfo)
Throws:
SnapshotException