public class VmInfo extends Object
Argument
annotation.
Typical arguments to be supplied by the user of the heap dump provider include
Argument.Advice.DIRECTORY
or Argument.Advice.SAVE
.Constructor and Description |
---|
VmInfo()
An empty constructor
|
VmInfo(int pid,
String description,
boolean heapDumpEnabled,
String proposedFileName,
IHeapDumpProvider heapDumpProvider)
Constructor with parameters
|
Modifier and Type | Method and Description |
---|---|
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
|
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(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(String proposedFileName)
Set the proposed file name for this process
|
String |
toString() |
public VmInfo()
public VmInfo(int pid, String description, boolean heapDumpEnabled, 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 VmInfopublic int getPid()
public void setPid(int pid)
pid
- public String getDescription()
public void setDescription(String description)
description
- public boolean isHeapDumpEnabled()
public void setHeapDumpEnabled(boolean heapDumpEnabled)
heapDumpEnabled
- public IHeapDumpProvider getHeapDumpProvider()
public void setHeapDumpProvider(IHeapDumpProvider heapDumpProvider)
heapDumpProvider
- public String getProposedFileName()
MessageUtil.format(java.lang.String, java.lang.Object...)
with three parameters, Date
date, int pid, int index
For example: mydumpname.{0,date,yyyyMMdd.HHmmss}.{1,number,0}.{2,number,0000}.dmppublic void setProposedFileName(String proposedFileName)
proposedFileName
-