Interface SnippetOutcome

All Known Subinterfaces:

SnippetOutcome.CompilerErrors, SnippetOutcome.CompilerSemanticErrors, SnippetOutcome.CompilerSyntaxErrors, SnippetOutcome.ControlViolation, SnippetOutcome.ExceptionThrown, SnippetOutcome.Interrupted, SnippetOutcome.Overwritten, SnippetOutcome.Successful, SnippetOutcome.SuccessfulNoValue, SnippetOutcome.SuccessfulWithValue, SnippetOutcome.Suspended, SnippetOutcome.UnresolvedReferences

public sealed interface SnippetOutcome
permits SnippetOutcome.CompilerErrors, SnippetOutcome.ControlViolation, SnippetOutcome.UnresolvedReferences, SnippetOutcome.Overwritten, SnippetOutcome.Suspended, SnippetOutcome.Interrupted, SnippetOutcome.ExceptionThrown, SnippetOutcome.Successful (not exhaustive)

Captures the outcome from one of the Snippets that constitute a JavaBox script.

A snippet can fail by failing to compile, compiling into bytecode that violates a Control, throwing an exception during execution, etc.

For some outcomes that implement SnippetOutcome.HasSnippet, additional information is available via the associated JShell snippet.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SnippetOutcome.CompilerErrors	Indicates failure due to one or more compiler errors.
static interface	SnippetOutcome.CompilerSemanticErrors	Indicates failure due to one or more compiler semantic errors.
static interface	SnippetOutcome.CompilerSyntaxErrors	Indicates failure due to one or more compiler parsing/syntax errors.
static interface	SnippetOutcome.ControlViolation	Indicates that the bytecode generated by the snippet could not be loaded because it violated some Control.
static interface	SnippetOutcome.ExceptionThrown	Indicates an exception was thrown during the execution of the snippet.
static interface	SnippetOutcome.HaltsScript	Implemented by SnippetOutcomes that will cause a script to stop executing.
static interface	SnippetOutcome.HasException<T extends Throwable>	Implemented by SnippetOutcomes for which there is an associated exception.
static interface	SnippetOutcome.HasSnippet	Implemented by SnippetOutcomes for which enough progress was made to define a JShell Snippet.
static interface	SnippetOutcome.Interrupted	Indicates that the snippet's execution was interrupted.
static interface	SnippetOutcome.Overwritten	Indicates that a declaration was successfully compiled, but the declaration was overwritten by a later snippet in the same source.
static interface	SnippetOutcome.Successful	Indicates a successful outcome.
static interface	SnippetOutcome.SuccessfulNoValue	Indicates a successful outcome for which no value was returned, e.g., the invocation of a void method, the declaration for which no unresolved references remain, etc.
static interface	SnippetOutcome.SuccessfulWithValue	Indicates a successful outcome for which some value was returned, e.g., an evaluated expression or the invocation of a non-void method.
static interface	SnippetOutcome.Suspended	Indicates that the snippet invoked JavaBox.suspend().
static interface	SnippetOutcome.UnresolvedReferences	Indicates that a declaration was successful but it contained unresolved references and those references were not resolved by any subsequent snippets in the same source.

Method Summary

Modifier and Type	Method	Description
JavaBox	box()	Get the associated JavaBox.
LineAndColumn	offset()	Get the position within the original script source of the source() associated with this instance.
String	source()	Get the source code of the snippet whose outcome is represented by this instance.

Method Details

box

JavaBox box()

Get the associated JavaBox.

Returns:

associated container

source

String source()

Get the source code of the snippet whose outcome is represented by this instance.

This will equal the substring of the original script source starting at offset().

Returns:

snippet source

See Also:

• offset()

offset

LineAndColumn offset()

Get the position within the original script source of the source() associated with this instance.

Returns:

snippet source offset in original script

See Also:

• source()