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 /**
  26  * A counter for some value of interest.
  27  */
  28 public interface CounterKey extends MetricKey {
  29 
  30     /**
  31      * Adds 1 to this counter.
  32      */
  33     void increment(DebugContext debug);
  34 
  35     /**
  36      * Adds {@code value} to this counter.
  37      */
  38     void add(DebugContext debug, long value);
  39 
  40     /**
  41      * Gets the current value of this counter.
  42      */
  43     long getCurrentValue(DebugContext debug);
  44 
  45     /**
  46      * Determines if this counter is enabled.
  47      */
  48     boolean isEnabled(DebugContext debug);
  49 
  50     @Override
  51     CounterKey doc(String string);
  52 }