org.graalvm.compiler.replacements

Class SnippetCounter

java.lang.Object

org.graalvm.compiler.replacements.SnippetCounter

All Implemented Interfaces:

Comparable<SnippetCounter>

public final class SnippetCounter
extends Object
implements Comparable<SnippetCounter>

A counter that can (only) be incremented from within a snippet for gathering snippet specific metrics.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SnippetCounter.Group A group of related counters.

Field Summary

Fields

Modifier and Type	Field and Description
static SnippetCounter	DISABLED_COUNTER

Constructor Summary

Constructors

Constructor and Description
SnippetCounter(SnippetCounter.Group group, String name, String description) Creates a counter.

Method Summary

Modifier and Type	Method and Description
void	add(int increment) Increments the value of this counter.
int	compareTo(SnippetCounter o) Sorts counters in descending order of their values.
SnippetCounter.Group	getGroup()
void	inc() Increments the value of this counter.
String	toString()
long	value() Gets the value of this counter.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DISABLED_COUNTER

public static final SnippetCounter DISABLED_COUNTER

Constructor Detail

SnippetCounter

public SnippetCounter(SnippetCounter.Group group,
                      String name,
                      String description)

Creates a counter.

Parameters:

group - the group to which the counter belongs. If this is null, the newly created counter is disabled and incrementing is a no-op.

name - the name of the counter

description - a brief comment describing the metric represented by the counter

Method Detail

compareTo

public int compareTo(SnippetCounter o)

Sorts counters in descending order of their values.

Specified by:

compareTo in interface Comparable<SnippetCounter>

getGroup

public SnippetCounter.Group getGroup()

inc

public void inc()

Increments the value of this counter. This method can only be used in a snippet on a compile-time constant SnippetCounter object.

add

public void add(int increment)

Increments the value of this counter. This method can only be used in a snippet on a compile-time constant SnippetCounter object.

value

public long value()

Gets the value of this counter.

toString

public String toString()

Overrides:

toString in class Object