Interface HeapDumpCollector

All Known Implementing Classes:
HeapDumpCollectorIBM, HeapDumpCollectorOracle

public interface HeapDumpCollector
Interface for classes that which to programmatically trigger a heap dump of the current JVM. Currrently, this only works with Oracle's "standard" and JRockit, along with IBM's, JVMs.
Author:
Laurent Cohen
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    This factory class generates instances of HeapDumpCollector based on the vendor name found in System.getProperty("java.vm.vendor").
  • Method Summary

    Modifier and Type
    Method
    Description
    Call this method from your application whenever you want to dump the heap snapshot into a file.
  • Method Details

    • dumpHeap

      String dumpHeap() throws Exception
      Call this method from your application whenever you want to dump the heap snapshot into a file.
      Returns:
      a message describing the outcome.
      Throws:
      Exception - if any error occurs