1 /*
   2  * Copyright (c) 2013, 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 /**
  26  * Object used to close a debug {@link Debug#indent() indentation} scope.
  27  * <p>
  28  * Example usage:
  29  *
  30  * <pre>
  31  *
  32  *      try (Indent i1 = Debug.logAndIndent("header message")) {
  33  *          ...
  34  *          Debug.log("message");
  35  *          ...
  36  *          try (Indent i2 = Debug.logAndIndent(sub-header message")) {
  37  *              ...
  38  *              Debug.log("inner message");
  39  *              ...
  40  *          }
  41  *      }
  42  *
  43  * </pre>
  44  */
  45 public interface Indent extends AutoCloseable {
  46 
  47     /**
  48      * Closes the current indentation scope.
  49      */
  50     @Override
  51     void close();
  52 }