org.netbeans.spi.editor.hints

Class ErrorDescription

java.lang.Object

org.netbeans.spi.editor.hints.ErrorDescription

public final class ErrorDescription
extends Object

Represents one error with a description text, span in the document, list of fixes and a severity. Please see the static methods in the class ErrorDescriptionFactory if you want to create instances of this class.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCustomType() The custom type is an annotation type provided for particular error
String	getDescription()
CharSequence	getDetails()
FileObject	getFile()
LazyFixList	getFixes() The list of fixes that will be associated with the error.
String	getId()
PositionBounds	getRange()
ArrayList<PositionBounds>	getRangeTail() Return range tail: to support multiple ranges for error/warning
Severity	getSeverity() The severity determines how the hint will be rendered.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getId

@CheckForNull
public String getId()

Returns:

the id specified when constructing this ErrorDescription, or null if none was specified

Since:

1.22

getDescription

public String getDescription()

Returns:

description of the error that is displayed to the user.

getDetails

@CheckForNull
public CharSequence getDetails()

Returns:

the details specified when constructing this ErrorDescription, or null if none was specified

Since:

1.22

getSeverity

public Severity getSeverity()

The severity determines how the hint will be rendered.

Returns:

Severity of the error

getCustomType

public String getCustomType()

The custom type is an annotation type provided for particular error

Returns:

custom annotation type

getFixes

public LazyFixList getFixes()

The list of fixes that will be associated with the error.

Returns:

LazyFixList containing the fixes

getRange

public PositionBounds getRange()

Returns:

where the error will be marked in the document or null if no place to mark

getRangeTail

public ArrayList<PositionBounds> getRangeTail()

Return range tail: to support multiple ranges for error/warning

Returns:

Since:

1.42

getFile

public FileObject getFile()

Returns:

associated file or null if there is none

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object