org.codehaus.plexus.compiler

Class CompilerError


public class CompilerError
extends java.lang.Object

This class encapsulates an error message produced by a programming language processor (whether interpreted or compiled)
Version:
$Id: CompilerError.java 2371 2005-07-31 18:05:08Z trygvis $
Author:
Stefano Mazzocchi
Since:
2.0

Field Summary

private int
endcolumn
The end column number of the offending program text
private int
endline
The end line number of the offending program text
private boolean
error
Is this a severe error or a warning?
private String
file
The name of the file containing the offending program text
private String
message
The actual error text produced by the language processor
private int
startcolumn
The start column number of the offending program text
private int
startline
The start line number of the offending program text

Constructor Summary

CompilerError(String message)
The warning message constructor.
CompilerError(String message, boolean error)
The error message constructor.
CompilerError(String file, boolean error, int startline, int startcolumn, int endline, int endcolumn, String message)
The error message constructor.

Method Summary

int
getEndColumn()
Return the ending column number of the program text originating this error
int
getEndLine()
Return the ending line number of the program text originating this error
String
getFile()
Return the filename associated with this compiler error.
String
getMessage()
Return the message produced by the language processor
int
getStartColumn()
Return the starting column number of the program text originating this error
int
getStartLine()
Return the starting line number of the program text originating this error
boolean
isError()
Assert whether this is a severe error or a warning
String
toString()

Field Details

endcolumn

private int endcolumn
The end column number of the offending program text

endline

private int endline
The end line number of the offending program text

error

private boolean error
Is this a severe error or a warning?

file

private String file
The name of the file containing the offending program text

message

private String message
The actual error text produced by the language processor

startcolumn

private int startcolumn
The start column number of the offending program text

startline

private int startline
The start line number of the offending program text

Constructor Details

CompilerError

public CompilerError(String message)
The warning message constructor.
Parameters:
message - The actual error text produced by the language processor

CompilerError

public CompilerError(String message,
                     boolean error)
The error message constructor.
Parameters:
message - The actual error text produced by the language processor
error - whether it was an error or informational

CompilerError

public CompilerError(String file,
                     boolean error,
                     int startline,
                     int startcolumn,
                     int endline,
                     int endcolumn,
                     String message)
The error message constructor.
Parameters:
file - The name of the file containing the offending program text
error - Is this a severe error or a warning?
startline - The start line number of the offending program text
startcolumn - The start column number of the offending program text
endline - The end line number of the offending program text
endcolumn - The end column number of the offending program text
message - The actual error text produced by the language processor

Method Details

getEndColumn

public int getEndColumn()
Return the ending column number of the program text originating this error
Returns:
The ending column number of the program text originating this error

getEndLine

public int getEndLine()
Return the ending line number of the program text originating this error
Returns:
The ending line number of the program text originating this error

getFile

public String getFile()
Return the filename associated with this compiler error.
Returns:
The filename associated with this compiler error

getMessage

public String getMessage()
Return the message produced by the language processor
Returns:
The message produced by the language processor

getStartColumn

public int getStartColumn()
Return the starting column number of the program text originating this error
Returns:
The starting column number of the program text originating this error

getStartLine

public int getStartLine()
Return the starting line number of the program text originating this error
Returns:
The starting line number of the program text originating this error

isError

public boolean isError()
Assert whether this is a severe error or a warning
Returns:
Whether the error is severe

toString

public String toString()