001/*
002 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.
008 *
009 * This code is distributed in the hope that it will be useful, but WITHOUT
010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
011 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
012 * version 2 for more details (a copy is included in the LICENSE file that
013 * accompanied this code).
014 *
015 * You should have received a copy of the GNU General Public License version
016 * 2 along with this work; if not, write to the Free Software Foundation,
017 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
018 *
019 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
020 * or visit www.oracle.com if you need additional information or have any
021 * questions.
022 */
023package com.oracle.graal.debug;
024
025/**
026 * Object used to close a debug {@link Debug#indent() indentation} scope.
027 * <p>
028 * Example usage:
029 *
030 * <pre>
031 *
032 *      try (Indent i1 = Debug.logAndIndent("header message")) {
033 *          ...
034 *          Debug.log("message");
035 *          ...
036 *          try (Indent i2 = Debug.logAndIndent(sub-header message")) {
037 *              ...
038 *              Debug.log("inner message");
039 *              ...
040 *          }
041 *      }
042 *
043 * </pre>
044 */
045public interface Indent extends AutoCloseable {
046
047    /**
048     * Closes the current indentation scope.
049     */
050    void close();
051}