1 /*
   2  * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 package org.graalvm.compiler.debug;
  24 
  25 import java.io.Closeable;
  26 
  27 /**
  28  * Interface implemented by classes that provide an external visualization of selected object types
  29  * such as compiler graphs and nodes. The format and client required to consume the visualizations
  30  * is determined by the implementation. For example, a dumper may convert a compiler node to a human
  31  * readable string and print it to the console. A more sophisticated dumper may serialize a compiler
  32  * graph and send it over the network to a tool (e.g., https://github.com/graalvm/visualizer) that
  33  * can display graphs.
  34  */
  35 public interface DebugDumpHandler extends Closeable, DebugHandler {
  36 
  37     /**
  38      * If the type of {@code object} is supported by this dumper, then a representation of
  39      * {@code object} is sent to some consumer in a format determined by this object.
  40      *
  41      * @param debug the debug context requesting the dump
  42      * @param object the object to be dumped
  43      * @param format a format string specifying a title that describes the context of the dump
  44      *            (e.g., the compiler phase in which request is made)
  45      * @param arguments arguments referenced by the format specifiers in {@code format}
  46      */
  47     void dump(DebugContext debug, Object object, String format, Object... arguments);
  48 
  49     /**
  50      * Flushes and releases resources managed by this dump handler. A subsequent call to
  51      * {@link #dump} will create and open new resources. That is, this method can be used to reset
  52      * the handler.
  53      */
  54     @Override
  55     default void close() {
  56     }
  57 }