blob: f0e3f6be951aeb496fd58a6e628e4d6599cb0df6 [file] [log] [blame]
/*
* Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package org.graalvm.compiler.debug;
/**
* A counter for some value of interest.
*/
public interface DebugCounter {
/**
* Adds 1 to this counter if counting is {@link Debug#isCountEnabled() enabled} or this is an
* {@linkplain #isConditional() unconditional} counter.
*/
void increment();
/**
* Adds {@code value} to this counter if counting is {@link Debug#isCountEnabled() enabled} or
* this is an {@linkplain #isConditional() unconditional} counter.
*/
void add(long value);
/**
* Sets a flag determining if this counter is only enabled if counting is
* {@link Debug#isCountEnabled() enabled}.
*/
void setConditional(boolean flag);
/**
* Determines if this counter is only enabled if counting is {@link Debug#isCountEnabled()
* enabled}.
*/
boolean isConditional();
/**
* Gets the current value of this counter.
*/
long getCurrentValue();
/**
* Determines if this counter is enabled (either conditionally or unconditionally).
*/
default boolean isEnabled() {
return !isConditional() || Debug.isCountEnabled();
}
}