java.lang.Object
jdk.jshell.Diag
Diagnostic information for a Snippet.
- Since:
- 9
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final longUsed to signal that no position is available. -
Method Summary
Modifier and TypeMethodDescriptionabstract StringgetCode()Returns a diagnostic code indicating the type of diagnostic.abstract longReturns the character offset from the beginning of the file associated with this diagnostic that indicates the end of the problem.abstract StringgetMessage(Locale locale) Returns a localized message for the given locale.abstract longReturns a character offset from the beginning of the source object associated with this diagnostic that indicates the location of the problem.abstract longReturns the character offset from the beginning of the file associated with this diagnostic that indicates the start of the problem.abstract booleanisError()Indicates whether this diagnostic is an error (as opposed to a warning or note).
-
Field Details
-
NOPOS
public static final long NOPOSUsed to signal that no position is available.- See Also:
-
-
Method Details
-
isError
public abstract boolean isError()Indicates whether this diagnostic is an error (as opposed to a warning or note).- Returns:
trueif this diagnostic is an error; otherwisefalse
-
getPosition
public abstract long getPosition()Returns a character offset from the beginning of the source object associated with this diagnostic that indicates the location of the problem. In addition, the following must be true:getStartPostion() <= getPosition()getPosition() <= getEndPosition()- Returns:
- character offset from beginning of source;
NOPOSif the position is not available.
-
getStartPosition
public abstract long getStartPosition()Returns the character offset from the beginning of the file associated with this diagnostic that indicates the start of the problem.- Returns:
- offset from beginning of file;
NOPOSif and only ifgetPosition()returnsNOPOS
-
getEndPosition
public abstract long getEndPosition()Returns the character offset from the beginning of the file associated with this diagnostic that indicates the end of the problem.- Returns:
- offset from beginning of file;
NOPOSif and only ifgetPosition()returnsNOPOS
-
getCode
Returns a diagnostic code indicating the type of diagnostic. The code is implementation-dependent and might benull.- Returns:
- a diagnostic code
-
getMessage
Returns a localized message for the given locale. The actual message is implementation-dependent. If the locale isnulluse the default locale.- Parameters:
locale- a locale; might benull- Returns:
- a localized message
-