Class HeapDumpOptions


  • public class HeapDumpOptions
    extends java.lang.Object
    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).
    • Constructor Detail

      • HeapDumpOptions

        public HeapDumpOptions()
        Create a new instance with the default options described above.
    • Method Detail

      • fullGc

        public HeapDumpOptions fullGc​(boolean fullGc)
        Determines whether a full garbage collection should be performed for the heap dump. The default is true.
        Parameters:
        fullGc - the new value
        Returns:
        this instance
      • primitiveData

        public HeapDumpOptions primitiveData​(boolean primitiveData)
        Determines whether primitive data should be recorded for the heap dump. The default is true.
        Parameters:
        primitiveData - the new value
        Returns:
        this instance
      • calculateRetainedSizes

        public HeapDumpOptions calculateRetainedSizes​(boolean calculateRetainedSizes)
        Determines whether retained sizes should be calculated for the heap dump. The default is true.
        Parameters:
        calculateRetainedSizes - the new value
        Returns:
        this instance
      • selectRecorded

        public HeapDumpOptions selectRecorded​(boolean selectRecorded)
        Determines whether recorded objects should be selected when the heap dump is opened in the JProfiler GUI. The default value is false.
        Parameters:
        selectRecorded - the new value
        Returns:
        this instance
      • retainSoftReferences

        public HeapDumpOptions retainSoftReferences​(boolean retainSoftReferences)
        Determines whether soft references should be considered for full GC. The default value is true. To remove objects that are only held by soft references, call this method with the argument false.
        Parameters:
        retainSoftReferences - whether soft references should be retained in the heap dump
        Returns:
        this instance
        See Also:
        fullGc
      • retainWeakReferences

        public HeapDumpOptions retainWeakReferences​(boolean retainWeakReferences)
        Determines whether weak references should be considered for full GC. The default value is false. To retain objects that are only held by weak references, call this method with the argument true.
        Parameters:
        retainWeakReferences - whether weak references should be retained in the heap dump
        Returns:
        this instance
        See Also:
        fullGc
      • retainPhantomReferences

        public HeapDumpOptions retainPhantomReferences​(boolean retainPhantomReferences)
        Determines whether phantom references should be considered for full GC. The default value is false. To retain objects that are only held by phantom references, call this method with the argument true.
        Parameters:
        retainPhantomReferences - whether phantom references should be retained in the heap dump
        Returns:
        this instance
        See Also:
        fullGc
      • retainFinalizerReferences

        public HeapDumpOptions retainFinalizerReferences​(boolean retainFinalizerReferences)
        Determines whether finalizer references should be considered for full GC. The default value is false. To retain objects that are only held by finalizer references, call this method with the argument true.
        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

        public HeapDumpOptions freeze()
        Make these heap dump options unmodifiable. Further modification attempts will result in a UnsupportedOperationException.
        Returns:
        this instance