Class HistogramInstructionTracer.Builder

java.lang.Object

com.oracle.truffle.api.bytecode.debug.HistogramInstructionTracer.Builder

Enclosing class:

HistogramInstructionTracer

public static final class HistogramInstructionTracer.Builder
extends Object

Builder for HistogramInstructionTracer.

The builder supports an optional filter predicate and an ordered list of group clauses. Group clauses are applied in the order they are added, producing a hierarchy of groups.

Since:

25.1

Method Summary

Modifier and Type	Method	Description
HistogramInstructionTracer	build(BytecodeDescriptor<?,?,?> descriptor)	Builds a HistogramInstructionTracer for the given BytecodeDescriptor.
HistogramInstructionTracer.Builder	filter(Predicate<BytecodeNode> filterClause)	Sets an optional filter predicate.
HistogramInstructionTracer.Builder	groupBy(HistogramInstructionTracer.GroupClause clause)	Adds a grouping clause to the histogram.

Methods inherited from class Object

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

Method Details

filter

public HistogramInstructionTracer.Builder filter(Predicate<BytecodeNode> filterClause)

Sets an optional filter predicate. If present, only bytecode nodes that satisfy the predicate contribute to counters.

Parameters:

filterClause - the predicate to apply, may be null

Returns:

this builder

Since:

25.1

groupBy

public HistogramInstructionTracer.Builder groupBy(HistogramInstructionTracer.GroupClause clause)

Adds a grouping clause to the histogram. Multiple clauses create a hierarchy, the first clause forms the top level, the last clause forms the leaves.

Parameters:

clause - the grouping clause to add, must not be null

Returns:

this builder

Throws:

NullPointerException - if clause is null

Since:

25.1

build

public HistogramInstructionTracer build(BytecodeDescriptor<?,?,?> descriptor)

Builds a HistogramInstructionTracer for the given BytecodeDescriptor.

Parameters:

descriptor - the descriptor to attach to

Returns:

a new tracer configured with the previously set filter and groups

Since:

25.1