com.oracle.truffle.api.instrumentation

Class SourceSectionFilter.Builder

java.lang.Object

com.oracle.truffle.api.instrumentation.SourceSectionFilter.Builder

Enclosing class:

SourceSectionFilter

public final class SourceSectionFilter.Builder
extends Object

Configure your own SourceSectionFilter before creating its instance. Specify various parameters by calling individual SourceSectionFilter.Builder methods. When done, call SourceSectionFilter.Builder.build().

Since:

0.12

Method Summary

Modifier and Type	Method and Description
SourceSectionFilter	build() Finalizes and constructs the SourceSectionFilter instance.
SourceSectionFilter.Builder	indexIn(int startIndex, int length) Add a filter for all sources sections where the index is inside a startIndex (inclusive) plus a given length (exclusive).
SourceSectionFilter.Builder	indexIn(SourceSectionFilter.IndexRange... ranges) Add a filter for all sources sections which indices are contained in one of the given index ranges.
SourceSectionFilter.Builder	indexNotIn(SourceSectionFilter.IndexRange... ranges) Add a filter for all sources sections which indices are not contained in one of the given index ranges.
SourceSectionFilter.Builder	lineEndsIn(SourceSectionFilter.IndexRange... ranges) Add a filter for all sources sections end in one of the given index ranges.
SourceSectionFilter.Builder	lineIn(int startLine, int length) Add a filter for all sources sections where the line is inside a startLine (first index inclusive) plus a given length (last index exclusive).
SourceSectionFilter.Builder	lineIn(SourceSectionFilter.IndexRange... ranges) Add a filter for all sources sections which lines are contained in one of the given index ranges.
SourceSectionFilter.Builder	lineIs(int line) Add a filter for all sources sections where the line is exactly the given line.
SourceSectionFilter.Builder	lineNotIn(SourceSectionFilter.IndexRange... ranges) Add a filter for all sources sections which lines are not contained in one of the given index ranges.
SourceSectionFilter.Builder	lineStartsIn(SourceSectionFilter.IndexRange... ranges) Add a filter for all sources sections start in one of the given index ranges.
SourceSectionFilter.Builder	mimeTypeIs(String... mimeTypes) Add a filter for all source sections that declare one of the given mime-types.
SourceSectionFilter.Builder	rootSourceSectionEquals(SourceSection... section) Add a filter for all root sources sections that equal one of the given source sections.
SourceSectionFilter.Builder	sourceIs(Source... source) Add a filter for all source sections that reference one of the given sources.
SourceSectionFilter.Builder	sourceIs(SourceSectionFilter.SourcePredicate predicate) Adds custom predicate to filter inclusion of sources.
SourceSectionFilter.Builder	sourceSectionEquals(SourceSection... section) Add a filter for all sources sections that equal one of the given source sections.
SourceSectionFilter.Builder	tagIs(Class<?>... tags) Add a filter for all source sections that are tagged with one of the given String tags.
SourceSectionFilter.Builder	tagIsNot(Class<?>... tags) Add a filter for all sources sections that declare not one of the given String tags.

Methods inherited from class java.lang.Object

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

Method Detail

sourceIs

public SourceSectionFilter.Builder sourceIs(Source... source)

Add a filter for all source sections that reference one of the given sources.

Since:

0.12

sourceIs

public SourceSectionFilter.Builder sourceIs(SourceSectionFilter.SourcePredicate predicate)

Adds custom predicate to filter inclusion of sources. The predicate must always return the same result for a source instance otherwise the behavior is undefined. The predicate should be able run on multiple threads at the same time.

Parameters:

predicate - a test for inclusion

Since:

0.17

mimeTypeIs

public SourceSectionFilter.Builder mimeTypeIs(String... mimeTypes)

Add a filter for all source sections that declare one of the given mime-types. Mime-types which are compared must match exactly one of the mime-types specified by the target guest language.

Parameters:

mimeTypes - matches one of the given mime types

Returns:

the builder to chain calls

Since:

0.12

tagIs

public SourceSectionFilter.Builder tagIs(Class<?>... tags)

Add a filter for all source sections that are tagged with one of the given String tags.

Parameters:

tags - matches one of the given tags

Returns:

the builder to chain calls

Since:

0.12

tagIsNot

public SourceSectionFilter.Builder tagIsNot(Class<?>... tags)

Add a filter for all sources sections that declare not one of the given String tags.

Parameters:

tags - matches not one of the given tags

Returns:

the builder to chain calls

Since:

0.12

sourceSectionEquals

public SourceSectionFilter.Builder sourceSectionEquals(SourceSection... section)

Add a filter for all sources sections that equal one of the given source sections.

Parameters:

section - matches one of the given source sections

Returns:

the builder to chain calls

Since:

0.12

rootSourceSectionEquals

public SourceSectionFilter.Builder rootSourceSectionEquals(SourceSection... section)

Add a filter for all root sources sections that equal one of the given source sections. All descendant source sections of a matching root source section are included in the filter. This can mean in the dynamic language domain that all nodes of a function for which the root source section matches the given source section is instrumented but its inner functions and its nodes are not instrumented.

Parameters:

section - matches one of the given root source sections

Returns:

the builder to chain calls

Since:

0.12

indexNotIn

public SourceSectionFilter.Builder indexNotIn(SourceSectionFilter.IndexRange... ranges)

Add a filter for all sources sections which indices are not contained in one of the given index ranges.

Parameters:

ranges - matches indices that are not contained one of the given index ranges

Returns:

the builder to chain calls

Since:

0.12

indexIn

public SourceSectionFilter.Builder indexIn(SourceSectionFilter.IndexRange... ranges)

Add a filter for all sources sections which indices are contained in one of the given index ranges.

Parameters:

ranges - matches indices that are contained one of the given index ranges

Returns:

the builder to chain calls

Since:

0.12

indexIn

public SourceSectionFilter.Builder indexIn(int startIndex,
                                           int length)

Add a filter for all sources sections where the index is inside a startIndex (inclusive) plus a given length (exclusive).

Parameters:

startIndex - the start index (inclusive)

length - the number of matched characters

Returns:

the builder to chain calls

Since:

0.12

lineIn

public SourceSectionFilter.Builder lineIn(SourceSectionFilter.IndexRange... ranges)

Add a filter for all sources sections which lines are contained in one of the given index ranges. Line indices must be greater or equal to 1.

Parameters:

ranges - matches lines that are contained one of the given index ranges

Returns:

the builder to chain calls

Since:

0.12

lineNotIn

public SourceSectionFilter.Builder lineNotIn(SourceSectionFilter.IndexRange... ranges)

Add a filter for all sources sections which lines are not contained in one of the given index ranges. Line indices must be greater or equal to 1.

Parameters:

ranges - matches lines that are not contained one of the given index ranges

Returns:

the builder to chain calls

Since:

0.12

lineIn

public SourceSectionFilter.Builder lineIn(int startLine,
                                          int length)

Add a filter for all sources sections where the line is inside a startLine (first index inclusive) plus a given length (last index exclusive).

Parameters:

startLine - the start line (inclusive)

length - the number of matched lines

Returns:

the builder to chain calls

Since:

0.12

lineStartsIn

public SourceSectionFilter.Builder lineStartsIn(SourceSectionFilter.IndexRange... ranges)

Add a filter for all sources sections start in one of the given index ranges. Line indices must be greater or equal to 1.

Parameters:

ranges - matches lines that start in one of the given index ranges

Returns:

the builder to chain calls

Since:

0.12

lineEndsIn

public SourceSectionFilter.Builder lineEndsIn(SourceSectionFilter.IndexRange... ranges)

Add a filter for all sources sections end in one of the given index ranges. Line indices must be greater or equal to 1.

Parameters:

ranges - matches lines that end in one of the given index ranges

Returns:

the builder to chain calls

Since:

0.12

lineIs

public SourceSectionFilter.Builder lineIs(int line)

Add a filter for all sources sections where the line is exactly the given line. Line indices must be greater or equal to 1. *

Parameters:

line - the line to be matched

Returns:

the builder to chain calls

Since:

0.12

build

public SourceSectionFilter build()

Finalizes and constructs the SourceSectionFilter instance.

Returns:

the built filter expression

Since:

0.12