org.netbeans.spi.java.hints

Class HintContext

java.lang.Object

org.netbeans.spi.java.hints.HintContext

public class HintContext
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HintContext.MessageKind

Method Summary

Modifier and Type	Method and Description
int	getCaretLocation() For suggestions, returns the caret location for the editor for which the suggestion is being computed.
Map<String,TypeMirror>	getConstraints()
CompilationInfo	getInfo()
Map<String,Collection<? extends TreePath>>	getMultiVariables()
TreePath	getPath()
Preferences	getPreferences()
Severity	getSeverity()
Map<String,String>	getVariableNames()
Map<String,TreePath>	getVariables()
boolean	isBulkMode() Returns true if the hint is being run in over many files, false if only the file opened in the editor is being inspected.
boolean	isCanceled() Returns true if the computation has been canceled.
void	reportMessage(HintContext.MessageKind kind, String text) Will be used only for refactoring(s), will be ignored for hints.

Methods inherited from class java.lang.Object

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

Method Detail

getInfo

public CompilationInfo getInfo()

getPreferences

public Preferences getPreferences()

getSeverity

public Severity getSeverity()

getPath

public TreePath getPath()

getVariables

public Map<String,TreePath> getVariables()

getMultiVariables

public Map<String,Collection<? extends TreePath>> getMultiVariables()

getVariableNames

public Map<String,String> getVariableNames()

getConstraints

public Map<String,TypeMirror> getConstraints()

reportMessage

public void reportMessage(HintContext.MessageKind kind,
                          String text)

Will be used only for refactoring(s), will be ignored for hints.

Parameters:

kind -

text -

isBulkMode

public boolean isBulkMode()

Returns true if the hint is being run in over many files, false if only the file opened in the editor is being inspected.

Returns:

true if the hint is being run in over many files.

isCanceled

public boolean isCanceled()

Returns true if the computation has been canceled.

Returns:

true if the computation has been canceled.

getCaretLocation

public int getCaretLocation()

For suggestions, returns the caret location for the editor for which the suggestion is being computed. Returns -1 for hints.

Returns:

for suggestions, returns the caret location, -1 otherwise