Interface HeapDumpWebEndpoint.HeapDumper

All Known Implementing Classes:
HeapDumpWebEndpoint.HotSpotDiagnosticMXBeanHeapDumper
Enclosing class:
HeapDumpWebEndpoint
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface protected static interface HeapDumpWebEndpoint.HeapDumper
Strategy interface used to dump the heap to a file.
Since:
2.0.0
Author:
Lari Hotari, Phillip Webb, Raja Kolli, Andy Wilkinson

  • Method Summary

    Modifier and Type
    Method
    Description
    File
    dumpHeap(@Nullable Boolean live)
    Dump the current heap to a file.

  • Method Details

    • dumpHeap

      File dumpHeap(@Nullable Boolean live) throws IOException, InterruptedException
      Dump the current heap to a file.
      Parameters:
      live - if only live objects (i.e. objects that are reachable from others) should be dumped. May be null to use a JVM-specific default.
      Returns:
      the file containing the heap dump
      Throws:
      IOException - on IO error
      InterruptedException - on thread interruption
      IllegalArgumentException - if live is non-null and is not supported by the JVM
      Since:
      3.0.0