Package com.jprofiler.api.controller
Class HeapDumpOptions
java.lang.Object
com.jprofiler.api.controller.HeapDumpOptions
Heap dump options for calling
Controller.triggerHeapDump(HeapDumpOptions)
The default values after constructing an instance of this class are equivalent to calling
heapDumpOptions.fullGc(true).primitiveData(true).calculateRetainedSizes(true).selectRecorded(true)
.-
Field Summary
Modifier and TypeFieldDescriptionstatic final HeapDumpOptions
The default value used byController.triggerHeapDump()
.static final HeapDumpOptions
Same asDEFAULT
, only withfullGc(false)
.static final HeapDumpOptions
Same asDEFAULT
, only withselectRecorded(true)
. -
Constructor Summary
ConstructorDescriptionCreate a new instance with the default options described above. -
Method Summary
Modifier and TypeMethodDescriptioncalculateRetainedSizes
(boolean calculateRetainedSizes) Determines whether retained sizes should be calculated for the heap dump.freeze()
Make these heap dump options unmodifiable.fullGc
(boolean fullGc) Determines whether a full garbage collection should be performed for the heap dump.boolean
Returns if retained sizes should be calculated for the heap dump.boolean
isFullGc()
Returns if a full garbage collection should be performed for the heap dump.boolean
Returns if primitive data should be recorded for the heap dump.boolean
Returns if finalizer references should retain objects in heap dump if full GC is selected.boolean
Returns if phantom references should retain objects in heap dump if full GC is selected.boolean
Returns if soft references should retain objects in heap dump if full GC is selected.boolean
Returns if weak references should retain objects in heap dump if full GC is selected.boolean
Returns if recorded objects should be selected when the heap dump is opened in the JProfiler GUI.primitiveData
(boolean primitiveData) Determines whether primitive data should be recorded for the heap dump.retainFinalizerReferences
(boolean retainFinalizerReferences) Determines whether finalizer references should be considered for full GC.retainPhantomReferences
(boolean retainPhantomReferences) Determines whether phantom references should be considered for full GC.retainSoftReferences
(boolean retainSoftReferences) Determines whether soft references should be considered for full GC.retainWeakReferences
(boolean retainWeakReferences) Determines whether weak references should be considered for full GC.selectRecorded
(boolean selectRecorded) Determines whether recorded objects should be selected when the heap dump is opened in the JProfiler GUI.
-
Field Details
-
DEFAULT
The default value used byController.triggerHeapDump()
. This uses the default options described above. -
SELECT_RECORDED
Same asDEFAULT
, only withselectRecorded(true)
. -
NO_FULL_GC
Same asDEFAULT
, only withfullGc(false)
.
-
-
Constructor Details
-
HeapDumpOptions
public HeapDumpOptions()Create a new instance with the default options described above.
-
-
Method Details
-
fullGc
Determines whether a full garbage collection should be performed for the heap dump. The default istrue
.- Parameters:
fullGc
- the new value- Returns:
- this instance
-
primitiveData
Determines whether primitive data should be recorded for the heap dump. The default istrue
.- Parameters:
primitiveData
- the new value- Returns:
- this instance
-
calculateRetainedSizes
Determines whether retained sizes should be calculated for the heap dump. The default istrue
.- Parameters:
calculateRetainedSizes
- the new value- Returns:
- this instance
-
selectRecorded
Determines whether recorded objects should be selected when the heap dump is opened in the JProfiler GUI. The default value isfalse
.- Parameters:
selectRecorded
- the new value- Returns:
- this instance
-
retainSoftReferences
Determines whether soft references should be considered for full GC. The default value istrue
. To remove objects that are only held by soft references, call this method with the argumentfalse
.- Parameters:
retainSoftReferences
- whether soft references should be retained in the heap dump- Returns:
- this instance
- See Also:
-
fullGc
-
retainWeakReferences
Determines whether weak references should be considered for full GC. The default value isfalse
. To retain objects that are only held by weak references, call this method with the argumenttrue
.- Parameters:
retainWeakReferences
- whether weak references should be retained in the heap dump- Returns:
- this instance
- See Also:
-
fullGc
-
retainPhantomReferences
Determines whether phantom references should be considered for full GC. The default value isfalse
. To retain objects that are only held by phantom references, call this method with the argumenttrue
.- Parameters:
retainPhantomReferences
- whether phantom references should be retained in the heap dump- Returns:
- this instance
- See Also:
-
fullGc
-
retainFinalizerReferences
Determines whether finalizer references should be considered for full GC. The default value isfalse
. To retain objects that are only held by finalizer references, call this method with the argumenttrue
.- Parameters:
retainFinalizerReferences
- whether finalizer references should be retained in the heap dump- Returns:
- this instance
- See Also:
-
fullGc
-
isFullGc
public boolean isFullGc()Returns if a full garbage collection should be performed for the heap dump.- Returns:
- the value
-
isPrimitiveData
public boolean isPrimitiveData()Returns if primitive data should be recorded for the heap dump.- Returns:
- the value
-
isCalculateRetainedSizes
public boolean isCalculateRetainedSizes()Returns if retained sizes should be calculated for the heap dump.- Returns:
- the value
-
isSelectRecorded
public boolean isSelectRecorded()Returns if recorded objects should be selected when the heap dump is opened in the JProfiler GUI.- Returns:
- the value
-
isRetainSoftReferences
public boolean isRetainSoftReferences()Returns if soft references should retain objects in heap dump if full GC is selected.- Returns:
- the value
- See Also:
-
fullGc
-
isRetainWeakReferences
public boolean isRetainWeakReferences()Returns if weak references should retain objects in heap dump if full GC is selected.- Returns:
- the value
- See Also:
-
fullGc
-
isRetainPhantomReferences
public boolean isRetainPhantomReferences()Returns if phantom references should retain objects in heap dump if full GC is selected.- Returns:
- the value
- See Also:
-
fullGc
-
isRetainFinalizerReferences
public boolean isRetainFinalizerReferences()Returns if finalizer references should retain objects in heap dump if full GC is selected.- Returns:
- the value
- See Also:
-
fullGc
-
freeze
Make these heap dump options unmodifiable. Further modification attempts will result in aUnsupportedOperationException
.- Returns:
- this instance
-