Modifier and Type	Class and Description
public static class	Snippet.Builder The builder of a `Snippet`.

Modifier and Type	Field and Description
private final Value	executableValue
private final String	id
private final List<? extends TypeDescriptor>	parameterTypes
private final TypeDescriptor	type
private final ResultVerifier	verifier

Access	Constructor and Description
private	Snippet(final String id, final Value executableValue, final TypeDescriptor type, final List<? extends TypeDescriptor> parameterTypes, final ResultVerifier verifier)

Method Summary

Modifier and Type	Method and Description
public Value	Returns: the executable `Value` getExecutableValue() Returns the function executing the `Snippet`.
public String	Returns: the `Snippet` identifier getId() Returns the identifier of a snippet.
public List<? extends TypeDescriptor>	Returns: the parameter types getParameterTypes() Returns the types of `Snippet` formal parameters.
public ResultVerifier	Returns: either a custom or the default `ResultVerifier`. getResultVerifier() Returns the `ResultVerifier` to verify the execution result.
public TypeDescriptor	Returns: the return type getReturnType() Returns the `Snippet` return type.
public static Snippet.Builder	Returns: the new `Builder` newBuilder(final String the `Snippet` identifier The `Snippet`s from a single `LanguageProvider` with the same identifier but different types are treated as overloads. id, final Value the executable `Value` used to execute the `Snippet` executableValue, final TypeDescriptor the `Snippet` return type executableReturnType) Creates a new `Snippet` builder object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

executableValue	back to summary
private final Value executableValue

id	back to summary
private final String id

parameterTypes	back to summary
private final List<? extends TypeDescriptor> parameterTypes

type	back to summary
private final TypeDescriptor type

verifier	back to summary
private final ResultVerifier verifier

Snippet	back to summary
private Snippet(final String id, final Value executableValue, final TypeDescriptor type, final List<? extends TypeDescriptor> parameterTypes, final ResultVerifier verifier)

Method Detail

getExecutableValue back to summary

getExecutableValue	back to summary
public Value getExecutableValue() Returns the function executing the `Snippet`. Returns:Value the executable `Value` Since 0.30

public Value getExecutableValue()

Returns the function executing the Snippet.

Returns:Value: the executable Value
Since: 0.30

getId back to summary

getId	back to summary
public String getId() Returns the identifier of a snippet. The `Snippet`s from a single `LanguageProvider` with the same identifier but different types are treated as overloads. Returns:String the `Snippet` identifier Since 0.30

public String getId()

Returns the identifier of a snippet. The Snippets from a single LanguageProvider with the same identifier but different types are treated as overloads.

Returns:String: the Snippet identifier
Since: 0.30

getParameterTypes back to summary

getParameterTypes	back to summary
public List<? extends TypeDescriptor> getParameterTypes() Returns the types of `Snippet` formal parameters. Returns:List<? extends TypeDescriptor> the parameter types Since 0.30

public List<? extends TypeDescriptor> getParameterTypes()

Returns the types of Snippet formal parameters.

Returns:List<? extends TypeDescriptor>: the parameter types
Since: 0.30

getResultVerifier back to summary

getResultVerifier	back to summary
public ResultVerifier getResultVerifier() Returns the `ResultVerifier` to verify the execution result. Returns:ResultVerifier either a custom or the default `ResultVerifier`. Since 0.30 See Also `ResultVerifier#accept(org.graalvm.polyglot.tck.ResultVerifier.SnippetRun).`

public ResultVerifier getResultVerifier()

Returns the ResultVerifier to verify the execution result.

Returns:ResultVerifier: either a custom or the default ResultVerifier.
Since: 0.30
See Also: ResultVerifier#accept(org.graalvm.polyglot.tck.ResultVerifier.SnippetRun).

getReturnType back to summary

getReturnType	back to summary
public TypeDescriptor getReturnType() Returns the `Snippet` return type. Returns:TypeDescriptor the return type Since 0.30

public TypeDescriptor getReturnType()

Returns the Snippet return type.

Returns:TypeDescriptor: the return type
Since: 0.30

newBuilder back to summary

newBuilder	back to summary
public static Snippet.Builder newBuilder(final String id, final Value executableValue, final TypeDescriptor executableReturnType) Creates a new `Snippet` builder object. Parameters id:String the `Snippet` identifier The `Snippet`s from a single `LanguageProvider` with the same identifier but different types are treated as overloads. executableValue:Value the executable `Value` used to execute the `Snippet` executableReturnType:TypeDescriptor the `Snippet` return type Returns:Snippet.Builder the new `Builder` Since 0.30

public static Snippet.Builder newBuilder(final String id, final Value executableValue, final TypeDescriptor executableReturnType)

Creates a new Snippet builder object.

Parameters

id:String: the Snippet identifier The Snippets from a single LanguageProvider with the same identifier but different types are treated as overloads.
executableValue:Value: the executable Value used to execute the Snippet
executableReturnType:TypeDescriptor: the Snippet return type

Returns:Snippet.Builder

the new Builder

Since

0.30

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override Since 0.30

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

Since

0.30

org.graalvm.polyglot.tck back to summary

public final Class Snippet.Builder

Class Inheritance

extends Object

java.lang.Object
org.graalvm.polyglot.tck.Snippet.Builder

The builder of a Snippet.

Since: 0.30

Field Summary

Modifier and Type	Field and Description
private TypeDescriptor	executableReturnType
private final Value	executableValue
private final String	id
private List<TypeDescriptor>	parameterTypes
private ResultVerifier	verifier

Constructor Summary

Access	Constructor and Description
private	Builder(final String id, final Value executableValue, final TypeDescriptor executableReturnType)

Method Summary

Modifier and Type	Method and Description
public Snippet	Returns: the `Snippet` build() Creates a new `Snippet` configured by this `Builder`.
public Snippet.Builder	Returns: this `Builder` parameterTypes(final TypeDescriptor... the types of `Snippet`'s parameters parameterTypes) Sets the `Snippet` formal parameter types.
public Snippet.Builder	Returns: this `Builder` resultVerifier(final ResultVerifier the custom `ResultVerifier` resultVerifier) Sets a custom verifier of a result of the `Snippet` execution.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

executableReturnType	back to summary
private TypeDescriptor executableReturnType

executableValue	back to summary
private final Value executableValue

id	back to summary
private final String id

parameterTypes	back to summary
private List<TypeDescriptor> parameterTypes

verifier	back to summary
private ResultVerifier verifier

Constructor Detail

Builder	back to summary
private Builder(final String id, final Value executableValue, final TypeDescriptor executableReturnType)

Method Detail

build back to summary

build	back to summary
public Snippet build() Creates a new `Snippet` configured by this `Builder`. Returns:Snippet the `Snippet` Since 0.30

public Snippet build()

Creates a new Snippet configured by this Builder.

Returns:Snippet: the Snippet
Since: 0.30

parameterTypes back to summary

parameterTypes	back to summary
public Snippet.Builder parameterTypes(final TypeDescriptor... parameterTypes) Sets the `Snippet` formal parameter types. Parameters parameterTypes:TypeDescriptor[] the types of `Snippet`'s parameters Returns:Snippet.Builder this `Builder` Since 0.30

public Snippet.Builder parameterTypes(final TypeDescriptor... parameterTypes)

Sets the Snippet formal parameter types.

Parameters

parameterTypes:TypeDescriptor[]: the types of Snippet's parameters

Returns:Snippet.Builder

this Builder

Since

0.30

resultVerifier back to summary

resultVerifier	back to summary
public Snippet.Builder resultVerifier(final ResultVerifier resultVerifier) Sets a custom verifier of a result of the `Snippet` execution. Parameters resultVerifier:ResultVerifier the custom `ResultVerifier` Returns:Snippet.Builder this `Builder` Since 0.30 See Also `ResultVerifier#accept(org.graalvm.polyglot.tck.ResultVerifier.SnippetRun).`

public Snippet.Builder resultVerifier(final ResultVerifier resultVerifier)

Sets a custom verifier of a result of the Snippet execution.

Parameters

resultVerifier:ResultVerifier: the custom ResultVerifier

Returns:Snippet.Builder

this Builder

Since

0.30

public final Class Snippet

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class Snippet.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail