org.netbeans.spi.lsp

Class ErrorProvider.Context

java.lang.Object

org.netbeans.spi.lsp.ErrorProvider.Context

Enclosing interface:

ErrorProvider

public static final class ErrorProvider.Context
extends Object

The context for the error provider.

Constructor Summary

Constructors

Constructor and Description
Context(FileObject file, ErrorProvider.Kind errorKind) Construct a new Context.
Context(FileObject file, int offset, ErrorProvider.Kind errorKind) Construct a new Context.
Context(FileObject file, int offset, ErrorProvider.Kind errorKind, FileObject hintsConfigFile) Construct a new Context.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel the computation.
ErrorProvider.Kind	errorKind() The type of errors/warnings should be computed.
FileObject	file() The file for which the errors/warnings should be computed.
FileObject	getHintsConfigFile() The file which contains preferences for the the errors/warnings to be computed.
int	getOffset() The offset for which the errors/warnings should be computed.
boolean	isCancelled() Checks if the computation should be cancelled.
void	registerCancelCallback(Runnable r) Register a Runnable which will be called when this computation is cancelled.

Methods inherited from class java.lang.Object

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

Constructor Detail

Context

public Context(FileObject file,
               ErrorProvider.Kind errorKind)

Construct a new Context.

Parameters:

file - file for which the errors/warnings should be computed

errorKind - the type of errors/warnings that should be computed

Context

public Context(FileObject file,
               int offset,
               ErrorProvider.Kind errorKind)

Construct a new Context.

Parameters:

file - file for which the errors/warnings should be computed

offset - offset for which the errors/warnings should be computed

errorKind - the type of errors/warnings that should be computed

Since:

1.4

Context

public Context(FileObject file,
               int offset,
               ErrorProvider.Kind errorKind,
               FileObject hintsConfigFile)

Construct a new Context.

Parameters:

file - file for which the errors/warnings should be computed

offset - offset for which the errors/warnings should be computed

errorKind - the type of errors/warnings that should be computed

hintsConfigFile - file which contains preferences for the the errors/warnings to be computed

Since:

1.25

Method Detail

getHintsConfigFile

public FileObject getHintsConfigFile()

The file which contains preferences for the the errors/warnings to be computed.

Returns:

the file which contains preferences for the the errors/warnings to be computed

Since:

1.25

file

public FileObject file()

The file for which the errors/warnings should be computed.

Returns:

the file for which the errors/warnings should be computed

getOffset

public int getOffset()

The offset for which the errors/warnings should be computed.

Returns:

the offset for which the errors/warnings should be computed

Since:

1.4

errorKind

public ErrorProvider.Kind errorKind()

The type of errors/warnings should be computed.

Returns:

the type of errors/warnings should be computed

isCancelled

public boolean isCancelled()

Checks if the computation should be cancelled.

Returns:

true iff the computation should be cancelled

cancel

public void cancel()

Cancel the computation.

registerCancelCallback

public void registerCancelCallback(Runnable r)

Register a Runnable which will be called when this computation is cancelled.

Parameters:

r - the cancel callback