ICompilerDiagnostic Interface

com.bea.ide.sourceeditor.compiler
ICompilerDiagnostic Interface

public interface ICompilerDiagnostic

Field Summary

public static final int
TYPE_ERROR
A constant representing a compile error.
public static final int
TYPE_INFO
A constant representing a compiler information diagnostic.
public static final int
TYPE_WARNING
A constant representing a compile warning.
 

Method Summary

public String
getCode()
Returns a code for the error.
public String
getDescription()
Returns the description of the diagnostic.
public String
getLanguage()
Returns the name of the langauge that generated this diagnostic
public int
getLength()
Returns the length of the diagnostic
public int
getOffset()
Returns the offset of the diagnostic
public String
getPrescription()
Returns the prescription for the diagnostic or null if none is exists.
public int
getType()
Returns the type of this diagnostic, one of TYPE_ERROR, TYPE_WARNING, or TYPE_INFO.

Field Detail

TYPE_ERROR

public static final int TYPE_ERROR
A constant representing a compile error. Errors will prevent full compilation of the source file and project.


TYPE_INFO

public static final int TYPE_INFO
A constant representing a compiler information diagnostic. These diagnostics are provided for informational purposes only, and have no effect on the compilation state of the file or project. They can be safely ignored by the end-user.


TYPE_WARNING

public static final int TYPE_WARNING
A constant representing a compile warning. Warnings will not prevent full compilation of the file or project, but the generally indicate a potential problem in source code that should be investigated.

 

Method Detail

getCode() Method

public String getCode()
Returns a code for the error.


getDescription() Method

public String getDescription()
Returns the description of the diagnostic.


getLanguage() Method

public String getLanguage()
Returns the name of the langauge that generated this diagnostic


getLength() Method

public int getLength()
Returns the length of the diagnostic


getOffset() Method

public int getOffset()
Returns the offset of the diagnostic


getPrescription() Method

public String getPrescription()
Returns the prescription for the diagnostic or null if none is exists.


getType() Method

public int getType()
Returns the type of this diagnostic, one of TYPE_ERROR, TYPE_WARNING, or TYPE_INFO.