jdk.jshell

Class SourceCodeAnalysis

java.lang.Object

jdk.jshell.SourceCodeAnalysis

public abstract class SourceCodeAnalysis
extends java.lang.Object

Provides analysis utilities for source code input. Optional functionality that provides for a richer interactive experience. Includes completion analysis: Is the input a complete snippet of code? Do I need to prompt for more input? Would adding a semicolon make it complete? Is there more than one snippet? etc. Also includes completion suggestions, as might be used in tab-completion.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SourceCodeAnalysis.Completeness Describes the completeness of the given input.
static class	SourceCodeAnalysis.CompletionInfo The result of analyzeCompletion(String input).
static class	SourceCodeAnalysis.Suggestion A candidate for continuation of the given user's input.

Constructor Summary

Constructors

Constructor and Description
SourceCodeAnalysis()

Method Summary

Modifier and Type	Method and Description
abstract SourceCodeAnalysis.CompletionInfo	analyzeCompletion(java.lang.String input) Given an input string, find the first snippet of code (one statement, definition, import, or expression) and evaluate if it is complete.
abstract java.util.List<SourceCodeAnalysis.Suggestion>	completionSuggestions(java.lang.String input, int cursor, int[] anchor) Compute possible follow-ups for the given input.
abstract java.lang.String	documentation(java.lang.String input, int cursor) Compute a description/help string for the given user's input.

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceCodeAnalysis

public SourceCodeAnalysis()

Method Detail

analyzeCompletion

public abstract SourceCodeAnalysis.CompletionInfo analyzeCompletion(java.lang.String input)

Given an input string, find the first snippet of code (one statement, definition, import, or expression) and evaluate if it is complete.

Parameters:

input - the input source string

Returns:

a CompletionInfo instance with location and completeness info

completionSuggestions

public abstract java.util.List<SourceCodeAnalysis.Suggestion> completionSuggestions(java.lang.String input,
                                                                                    int cursor,
                                                                                    int[] anchor)

Compute possible follow-ups for the given input. Uses information from the current JShell state, including type information, to filter the suggestions.

Parameters:

input - the user input, so far

cursor - the current position of the cursors in the given input text

anchor - outgoing parameter - when an option will be completed, the text between the anchor and cursor will be deleted and replaced with the given option

Returns:

list of candidate continuations of the given input.

documentation

public abstract java.lang.String documentation(java.lang.String input,
                                               int cursor)

Compute a description/help string for the given user's input.

Parameters:

input - the snippet the user wrote so far

cursor - the current position of the cursors in the given input text

Returns:

description/help string for the given user's input