Package org.codehaus.groovy.control
Class ErrorCollector
- java.lang.Object
- 
- org.codehaus.groovy.control.ErrorCollector
 
- 
- All Implemented Interfaces:
- Serializable
 
 public class ErrorCollector extends Object implements Serializable A base class for collecting messages and errors during processing. Each CompilationUnit should have an ErrorCollector, and the SourceUnits should share their ErrorCollector with the CompilationUnit.- See Also:
- Serialized Form
 
- 
- 
Field SummaryFields Modifier and Type Field Description protected CompilerConfigurationconfigurationConfiguration and other settings that control processingprotected LinkedList<Message>errorsErrorMessages collected during processingprotected LinkedList<WarningMessage>warningsWarningMessages collected during processing
 - 
Constructor SummaryConstructors Constructor Description ErrorCollector(CompilerConfiguration configuration)Initialize the ErrorReporter.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddCollectorContents(ErrorCollector that)voidaddError(String error, CSTNode context, SourceUnit source)voidaddError(Message message)Adds a non-fatal error to the message set, which may cause a failure if the error threshold is exceeded.voidaddError(Message message, boolean fatal)Adds an optionally-fatal error to the message set.voidaddError(SyntaxException error, SourceUnit source)voidaddErrorAndContinue(String error, ASTNode node, SourceUnit source)voidaddErrorAndContinue(Message message)Adds an error to the message set, but does not cause a failure.voidaddErrorAndContinue(SyntaxException error, SourceUnit source)voidaddException(Exception exception, SourceUnit source)voidaddFatalError(Message message)Adds an error to the message set and throws CompilationFailedException.voidaddWarning(int importance, String text, Object data, CSTNode context, SourceUnit source)Adds a warning to the message set if it is relevant.voidaddWarning(int importance, String text, CSTNode context, SourceUnit source)Adds a warning to the message set if it is relevant.voidaddWarning(WarningMessage message)Adds a warning to the message set.protected voidfailIfErrors()Causes the current phase to fail by throwing a CompilationFailedException.CompilerConfigurationgetConfiguration()MessagegetError(int index)Returns the specified error message, or null.intgetErrorCount()Returns the number of errors.List<? extends Message>getErrors()Returns the list of errors, or null if there are none.ExceptiongetException(int index)Returns the specified error's underlying Exception, or null if it isn't one.MessagegetLastError()Returns the last error reported.SyntaxExceptiongetSyntaxError(int index)Returns the specified error's underlying SyntaxException, or null if it isn't one.WarningMessagegetWarning(int index)Returns the specified warning message, or null.intgetWarningCount()Returns the number of warnings.List<WarningMessage>getWarnings()Returns the list of warnings, or null if there are none.booleanhasErrors()Returns true if there are any errors pending.booleanhasWarnings()Returns true if there are any warnings pending.voidwrite(PrintWriter writer, Janitor janitor)Writes error messages to the specified PrintWriter.
 
- 
- 
- 
Field Detail- 
errorsprotected LinkedList<Message> errors ErrorMessages collected during processing
 - 
warningsprotected LinkedList<WarningMessage> warnings WarningMessages collected during processing
 - 
configurationprotected final CompilerConfiguration configuration Configuration and other settings that control processing
 
- 
 - 
Constructor Detail- 
ErrorCollectorpublic ErrorCollector(CompilerConfiguration configuration) Initialize the ErrorReporter.
 
- 
 - 
Method Detail- 
addCollectorContentspublic void addCollectorContents(ErrorCollector that) 
 - 
addErrorAndContinuepublic void addErrorAndContinue(SyntaxException error, SourceUnit source) throws CompilationFailedException - Throws:
- CompilationFailedException
 
 - 
addErrorAndContinuepublic void addErrorAndContinue(Message message) Adds an error to the message set, but does not cause a failure. The message is not required to have a source line and column specified, but it is best practice to try and include that information.
 - 
addErrorAndContinuepublic void addErrorAndContinue(String error, ASTNode node, SourceUnit source) 
 - 
addErrorpublic void addError(Message message) throws CompilationFailedException Adds a non-fatal error to the message set, which may cause a failure if the error threshold is exceeded. The message is not required to have a source line and column specified, but it is best practice to try and include that information.- Throws:
- CompilationFailedException
 
 - 
addErrorpublic void addError(Message message, boolean fatal) throws CompilationFailedException Adds an optionally-fatal error to the message set. The message is not required to have a source line and column specified, but it is best practice to try and include that information.- Parameters:
- fatal- if true then then processing will stop
- Throws:
- CompilationFailedException
 
 - 
addErrorpublic void addError(SyntaxException error, SourceUnit source) throws CompilationFailedException - Throws:
- CompilationFailedException
 
 - 
addErrorpublic void addError(String error, CSTNode context, SourceUnit source) throws CompilationFailedException - Throws:
- CompilationFailedException
 
 - 
addExceptionpublic void addException(Exception exception, SourceUnit source) throws CompilationFailedException - Throws:
- CompilationFailedException
 
 - 
addFatalErrorpublic void addFatalError(Message message) throws CompilationFailedException Adds an error to the message set and throws CompilationFailedException.- Throws:
- CompilationFailedException
 
 - 
addWarningpublic void addWarning(WarningMessage message) Adds a warning to the message set.
 - 
addWarningpublic void addWarning(int importance, String text, CSTNode context, SourceUnit source)Adds a warning to the message set if it is relevant.
 - 
addWarningpublic void addWarning(int importance, String text, Object data, CSTNode context, SourceUnit source)Adds a warning to the message set if it is relevant.
 - 
getConfigurationpublic CompilerConfiguration getConfiguration() - Returns:
- the compiler configuration used to create this error collector
 
 - 
getErrorCountpublic int getErrorCount() Returns the number of errors.
 - 
getErrorpublic Message getError(int index) Returns the specified error message, or null.
 - 
getErrorspublic List<? extends Message> getErrors() Returns the list of errors, or null if there are none.
 - 
hasErrorspublic boolean hasErrors() Returns true if there are any errors pending.
 - 
getWarningCountpublic int getWarningCount() Returns the number of warnings.
 - 
getWarningpublic WarningMessage getWarning(int index) Returns the specified warning message, or null.
 - 
getWarningspublic List<WarningMessage> getWarnings() Returns the list of warnings, or null if there are none.
 - 
hasWarningspublic boolean hasWarnings() Returns true if there are any warnings pending.
 - 
getLastErrorpublic Message getLastError() Returns the last error reported.
 - 
getExceptionpublic Exception getException(int index) Returns the specified error's underlying Exception, or null if it isn't one.
 - 
getSyntaxErrorpublic SyntaxException getSyntaxError(int index) Returns the specified error's underlying SyntaxException, or null if it isn't one.
 - 
failIfErrorsprotected void failIfErrors() throws CompilationFailedExceptionCauses the current phase to fail by throwing a CompilationFailedException.- Throws:
- CompilationFailedException
 
 - 
writepublic void write(PrintWriter writer, Janitor janitor) Writes error messages to the specified PrintWriter.
 
- 
 
-