|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.mat.snapshot.acquire.VmInfo
public class VmInfo
Instances of this class are descriptors of locally running Java processes.
Arguments can be injected into the query using public fields marked with the Argument
annotation.
Typical arguments to be supplied by the user of the heap dump provider include
Argument.Advice.DIRECTORY
or Argument.Advice.SAVE
.
Constructor Summary | |
---|---|
VmInfo()
An empty constructor |
|
VmInfo(int pid,
java.lang.String description,
boolean heapDumpEnabled,
java.lang.String proposedFileName,
IHeapDumpProvider heapDumpProvider)
Constructor with parameters |
Method Summary | |
---|---|
java.lang.String |
getDescription()
Get the description of the Java process |
IHeapDumpProvider |
getHeapDumpProvider()
Get the heap dump provider which returned this VmInfo |
int |
getPid()
Get the PID of the process |
java.lang.String |
getProposedFileName()
Returns a proposed file name under which the heap dump should be saved, e.g. |
boolean |
isHeapDumpEnabled()
Indicate if a heap dump can be acquired from the described process |
void |
setDescription(java.lang.String description)
Set the description of the Java process |
void |
setHeapDumpEnabled(boolean heapDumpEnabled)
Set the flag if heap dumps can be acquired from the described process |
void |
setHeapDumpProvider(IHeapDumpProvider heapDumpProvider)
Set the heap dump provider of this VmInfo |
void |
setPid(int pid)
Set the PID for the process descriptor |
void |
setProposedFileName(java.lang.String proposedFileName)
Set the proposed file name for this process |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public VmInfo()
public VmInfo(int pid, java.lang.String description, boolean heapDumpEnabled, java.lang.String proposedFileName, IHeapDumpProvider heapDumpProvider)
pid
- the process ID of the processdescription
- a free text description of the process, usually the process
nameheapDumpEnabled
- a boolean value indicating if a heap dump from the process can
be acquiredproposedFileName
- a proposal for the file name, under which the heap dump can be
saved. %pid% can be used as a placeholder for the PID.
Example: java_pid%pid%.hprofheapDumpProvider
- the IHeapDumpProvider
which can use this VmInfoMethod Detail |
---|
public int getPid()
public void setPid(int pid)
pid
- public java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- public boolean isHeapDumpEnabled()
public void setHeapDumpEnabled(boolean heapDumpEnabled)
heapDumpEnabled
- public IHeapDumpProvider getHeapDumpProvider()
public void setHeapDumpProvider(IHeapDumpProvider heapDumpProvider)
heapDumpProvider
- public java.lang.String getProposedFileName()
public void setProposedFileName(java.lang.String proposedFileName)
proposedFileName
- public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |