org.eclipse.mat.hprof.acquire

Class JMapHeapDumpProvider

java.lang.Object

org.eclipse.mat.hprof.acquire.JMapHeapDumpProvider

All Implemented Interfaces:

IHeapDumpProvider

public class JMapHeapDumpProvider
extends Object
implements IHeapDumpProvider

Field Summary

Fields

Modifier and Type	Field and Description
boolean	defaultCompress
File	jdkHome

Constructor Summary

Constructors

Constructor and Description
JMapHeapDumpProvider()

Method Summary

Modifier and Type	Method and Description
File	acquireDump(VmInfo info, File preferredLocation, IProgressListener listener) Acquire a heap dump from a locally running Java process.
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 File jdkHome

defaultCompress

public boolean defaultCompress

Constructor Detail

JMapHeapDumpProvider

public JMapHeapDumpProvider()

Method Detail

acquireDump

public File acquireDump(VmInfo info,
                        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 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:

A List of VMs, of a type which extends VmInfo.

Throws:

SnapshotException