jdk-sandbox: comparison langtools/src/jdk.jshell/share/classes/jdk/jshell/SourceCodeAnalysis.java

equal deleted inserted replaced

-:7693aa00e131
+:f0c186d76c8a
 */
 public abstract CompletionInfo analyzeCompletion(String input);
 /**
 * Compute possible follow-ups for the given input.
-* Uses information from the current <code>JShell</code> state, including
+* Uses information from the current {@code JShell} state, including
 * type information, to filter the suggestions.
 * @param input the user input, so far
 * @param cursor the current position of the cursors in the given {@code input} text
 * @param 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
 * Internal only constructor
 */
 SourceCodeAnalysis() {}
 /**
-* The result of <code>analyzeCompletion(String input)</code>.
+* The result of {@code analyzeCompletion(String input)}.
 * Describes the completeness and position of the first snippet in the given input.
 */
 public static class CompletionInfo {
+private final Completeness completeness;
+private final int unitEndPos;
+private final String source;
+private final String remaining;
 CompletionInfo(Completeness completeness, int unitEndPos, String source, String remaining) {
 this.completeness = completeness;
 this.unitEndPos = unitEndPos;
 this.source = source;
 this.remaining = remaining;
 }
 /**
 * The analyzed completeness of the input.
-*/
+*
-public final Completeness completeness;
+* @return an enum describing the completeness of the input string.
+*/
-/**
+public Completeness completeness() {
-* The end of the first unit of source.
+return completeness;
-*/
+}
-public final int unitEndPos;
+/**
-/**
+* Input remaining after the complete part of the source.
-* Source code for the first unit of code input.  For example, first
+*
-* statement, or first method declaration.  Trailing semicolons will
+* @return the portion of the input string that remains after the
-* be added, as needed
+* complete Snippet
 */
-public final String source;
+public String remaining() {
+return remaining;
-/**
+}
-* Input remaining after the source
-*/
+/**
-public final String remaining;
+* Source code for the first Snippet of code input. For example, first
+* statement, or first method declaration. Trailing semicolons will be
+* added, as needed.
+*
+* @return the source of the first encountered Snippet
+*/
+public String source() {
+return source;
+}
+/**
+* The end of the first Snippet of source.
+*
+* @return the position of the end of the first Snippet in the input.
+*/
+public int unitEndPos() {
+return unitEndPos;
+}
 }
 /**
 * Describes the completeness of the given input.
 */
 * The input is considered complete because evaluating is the best
 * mechanism to get error information.
 */
 UNKNOWN(true);
-/**
+private final boolean isComplete;
-* Is the first snippet of source complete. For example, "x=" is not
-* complete, but "x=2" is complete, even though a subsequent line could
-* make it "x=2+2". Already erroneous code is marked complete.
-*/
-public final boolean isComplete;
 Completeness(boolean isComplete) {
 this.isComplete = isComplete;
 }
+/**
+* Indicates whether the first snippet of source is complete.
+* For example, "{@code x=}" is not
+* complete, but "{@code x=2}" is complete, even though a subsequent line could
+* make it "{@code x=2+2}". Already erroneous code is marked complete.
+*
+* @return {@code true} if the input is or begins a complete Snippet;
+* otherwise {@code false}
+*/
+public boolean isComplete() {
+return isComplete;
+}
 }
 /**
 * A candidate for continuation of the given user's input.
 */
 public static class Suggestion {
+private final String continuation;
+private final boolean matchesType;
 /**
 * Create a {@code Suggestion} instance.
+*
 * @param continuation a candidate continuation of the user's input
-* @param isSmart is the candidate "smart"
+* @param matchesType does the candidate match the target type
 */
-public Suggestion(String continuation, boolean isSmart) {
+public Suggestion(String continuation, boolean matchesType) {
 this.continuation = continuation;
-this.isSmart = isSmart;
+this.matchesType = matchesType;
 }
 /**
 * The candidate continuation of the given user's input.
-*/
+*
-public final String continuation;
+* @return the continuation string
+*/
-/**
+public String continuation() {
-* Is it an input continuation that matches the target type and is thus more
+return continuation;
-* likely to be the desired continuation. A smart continuation
+}
-* is preferred.
-*/
+/**
-public final boolean isSmart;
+* Indicates whether input continuation matches the target type and is thus
+* more likely to be the desired continuation. A matching continuation is
+* preferred.
+*
+* @return {@code true} if this suggested continuation matches the
+* target type; otherwise {@code false}
+*/
+public boolean matchesType() {
+return matchesType;
+}
 }
 /**
 * List of possible qualified names.
 */
 public int getSimpleNameLength() {
 return simpleNameLength;
 }
 /**
-* Whether the result is based on up to date data. The
+* Indicates whether the result is based on up to date data. The
 * {@link SourceCodeAnalysis#listQualifiedNames(java.lang.String, int) listQualifiedNames}
 * method may return before the classpath is fully inspected, in which case this method will
 * return {@code false}. If the result is based on a fully inspected classpath, this method
 * will return {@code true}.
 *
-* @return true iff the results is based on up-to-date data
+* @return {@code true} if the result is based on up-to-date data;
+* otherwise {@code false}
 */
 public boolean isUpToDate() {
 return upToDate;
 }
 /**
-* Whether the given simple name in the original code refers to a resolvable element.
+* Indicates whether the given simple name in the original code refers
-*
+* to a resolvable element.
-* @return true iff the given simple name in the original code refers to a resolvable element
+*
+* @return {@code true} if the given simple name in the original code
+* refers to a resolvable element; otherwise {@code false}
 */
 public boolean isResolvable() {
 return resolvable;
 }

changeset 38908	f0c186d76c8a
parent 36160	f42d362d0d17
child 39370	437ba9bd2582