oracle.javatools.status

Interface Issue

All Known Subinterfaces:

Violation

public interface Issue

An issue in a file. An issue has a message and a severity, is associated with a range of text in the file, and may have transforms--actions that address the issue--attached to it.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getConstruct() Gets the model object associated with this issue, if any.
java.lang.String	getHtmlMessage() Gets a translated HTML formatted text message describing this issue.
int	getLength() Gets the length of the text associated with this issue.
java.lang.String	getMessage() Gets a translated plain text message describing this issue.
int	getOffset() Gets the offset of the text associated with this issue.
Severity	getSeverity() Gets the Severity of this issue.
java.util.List<? extends javax.swing.Action>	getTransforms() Gets the transforms attached to this issue.
boolean	hasTransforms() Gets whether any transforms are attached to this issue.

Method Detail

getConstruct

java.lang.Object getConstruct()

Gets the model object associated with this issue, if any.

Some implementations of this method require one kind or another of locking, but this interface does not expose any methods for that so it is not practical to ask clients to do the locking. Therefore, the implementations of this method must do any required locking. In practice, this mostly means implementations that extend the Audit framework's Violation interface.

Even though the implementations do not require client locking, the source models for most oracle.ide.model.Node types actually do expect clients to hold a lock, usually the Node/TextBuffer lock, while holding constructs of the source model. Consequently, taking the appropriate lock before calling this method is recommended.

getMessage

java.lang.String getMessage()

Gets a translated plain text message describing this issue.

getHtmlMessage

java.lang.String getHtmlMessage()

Gets a translated HTML formatted text message describing this issue.

getSeverity

Severity getSeverity()

Gets the Severity of this issue.

getOffset

int getOffset()

Gets the offset of the text associated with this issue.

getLength

int getLength()

Gets the length of the text associated with this issue.

hasTransforms

boolean hasTransforms()

Gets whether any transforms are attached to this issue.

getTransforms

java.util.List<? extends javax.swing.Action> getTransforms()

Gets the transforms attached to this issue.