org.elasticsearch.painless

Interface PainlessScript

public interface PainlessScript

Abstract superclass on top of which all Painless scripts are built.

Method Summary

Modifier and Type	Method and Description
default ScriptException	convertToScriptException(java.lang.Throwable t, java.util.Map<java.lang.String,java.util.List<java.lang.String>> extraMetadata) Adds stack trace and other useful information to exceptions thrown from a Painless script.
java.lang.String	getName()
default int	getNextStatement(int offset) Finds the start of the first statement boundary that is after offset.
default int	getPreviousStatement(int offset) Finds the start of the first statement boundary that is on or before offset.
java.lang.String	getSource()
java.util.BitSet	getStatements()
default boolean	shouldFilter(java.lang.StackTraceElement element) returns true for methods that are part of the runtime

Method Detail

getName

java.lang.String getName()

Returns:

The name of the script retrieved from a static variable generated during compilation of a Painless script.

getSource

java.lang.String getSource()

Returns:

The source for a script retrieved from a static variable generated during compilation of a Painless script.

getStatements

java.util.BitSet getStatements()

Returns:

The BitSet tracking the boundaries for statements necessary for good exception messages.

convertToScriptException

default ScriptException convertToScriptException(java.lang.Throwable t,
                                                 java.util.Map<java.lang.String,java.util.List<java.lang.String>> extraMetadata)

Adds stack trace and other useful information to exceptions thrown from a Painless script.

Parameters:

t - The throwable to build an exception around.

Returns:

The generated ScriptException.

shouldFilter

default boolean shouldFilter(java.lang.StackTraceElement element)

returns true for methods that are part of the runtime

getPreviousStatement

default int getPreviousStatement(int offset)

Finds the start of the first statement boundary that is on or before offset. If one is not found, -1 is returned.

getNextStatement

default int getNextStatement(int offset)

Finds the start of the first statement boundary that is after offset. If one is not found, -1 is returned.