org.netbeans.spi.editor.hints

Class HintsController

java.lang.Object

org.netbeans.spi.editor.hints.HintsController

public final class HintsController
extends Object

One of the main entry points for the Editor Hints SPI. Call one of the setErrors method to change the hints on the document.

Method Summary

Modifier and Type	Method and Description
static void	setErrors(Document doc, String layer, Collection<? extends ErrorDescription> errors) Assign given list of errors to a file.
static void	setErrors(FileObject file, String layer, Collection<? extends ErrorDescription> errors) Assign given list of errors to a given file.

Methods inherited from class java.lang.Object

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

Method Detail

setErrors

public static void setErrors(@NonNull
                             Document doc,
                             @NonNull
                             String layer,
                             @NonNull
                             Collection<? extends ErrorDescription> errors)

Assign given list of errors to a file. This removes any errors that were assigned to this file before under the same "layer". The file to which the errors should be assigned is gathered from the given document.

Parameters:

doc - document to which the errors should be assigned

layer - unique layer ID

errors - to use

setErrors

public static void setErrors(@NonNull
                             FileObject file,
                             @NonNull
                             String layer,
                             @NonNull
                             Collection<? extends ErrorDescription> errors)

Assign given list of errors to a given file. This removes any errors that were assigned to this file before under the same "layer".

Parameters:

file - to which the errors should be assigned

layer - unique layer ID

errors - to use