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 */
23package org.graalvm.compiler.debug;
24
25import org.graalvm.compiler.debug.internal.DebugScope;
26
27/**
28 * A utility for scoping a change to the current debug {@linkplain DebugScope#setConfig(DebugConfig)
29 * configuration}. For example:
30 *
31 * <pre>
32 *     DebugConfig config = ...;
33 *     try (DebugConfigScope s = new DebugConfigScope(config)) {
34 *         // ...
35 *     }
36 * </pre>
37 */
38public class DebugConfigScope implements AutoCloseable {
39
40    private final DebugConfig current;
41
42    /**
43     * Sets the current debug {@linkplain DebugScope#setConfig(DebugConfig) configuration} to a
44     * given value and creates an object that when {@linkplain #close() closed} resets the
45     * configuration to the {@linkplain DebugScope#getConfig() current} configuration.
46     */
47    public DebugConfigScope(DebugConfig config) {
48        this.current = DebugScope.getConfig();
49        DebugScope.getInstance().setConfig(config);
50    }
51
52    @Override
53    public void close() {
54        DebugScope.getInstance().setConfig(current);
55    }
56}
57