ErrorCollector (groovy 2.4.0 API)

org.codehaus.groovy.control.ErrorCollector

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.
Authors:
Chris Poirier
Jochen Theodorou
Version:
\$Id\$

Field Summary

Fields
Modifiers	Name	Description
`protected CompilerConfiguration`	`configuration`	Configuration and other settings that control processing
`protected LinkedList`	`errors`	ErrorMessages collected during processing
`protected LinkedList`	`warnings`	WarningMessages collected during processing

Constructor Summary

Constructors
Constructor and description
`ErrorCollector (CompilerConfiguration configuration)` Initialize the ErrorReporter.

Methods Summary

Methods
Type	Name and description
`void`	`addCollectorContents(ErrorCollector er)`
`void`	`addError(Message message)` Adds a non-fatal error to the message set, which may cause a failure if the error threshold is exceeded.
`void`	`addError(Message message, boolean fatal)` Adds an optionally-fatal error to the message set.
`void`	`addError(SyntaxException error, SourceUnit source)` Convenience wrapper for addError().
`void`	`addError(String text, CSTNode context, SourceUnit source)` Convenience wrapper for addError().
`void`	`addErrorAndContinue(Message message)` Adds an error to the message set, but does not cause a failure.
`void`	`addException(Exception cause, SourceUnit source)`
`void`	`addFatalError(Message message)` Adds a fatal exception to the message set and throws the unit as a PhaseFailedException.
`void`	`addWarning(WarningMessage message)` Adds a WarningMessage to the message set.
`void`	`addWarning(int importance, String text, CSTNode context, SourceUnit source)` Convenience wrapper for addWarning() that won't create an object unless it is relevant.
`void`	`addWarning(int importance, String text, Object data, CSTNode context, SourceUnit source)` Convenience wrapper for addWarning() that won't create an object unless it is relevant.
`protected void`	`failIfErrors()` Causes the current phase to fail by throwing a CompilationFailedException.
`CompilerConfiguration`	`getConfiguration()` @return the compiler configuration used to create this error collector
`Message`	`getError(int index)` Returns the specified error message, or null.
`int`	`getErrorCount()` Returns the number of errors.
`List`	`getErrors()` Returns the list of errors, or null if there are none.
`Exception`	`getException(int index)` Convenience routine to return the specified error's underlying Exception, or null if it isn't one.
`Message`	`getLastError()` Returns the last error reported
`SyntaxException`	`getSyntaxError(int index)` Convenience routine to return the specified error's underlying SyntaxException, or null if it isn't one.
`WarningMessage`	`getWarning(int index)` Returns the specified warning message, or null.
`int`	`getWarningCount()` Returns the number of warnings.
`List`	`getWarnings()` Returns the list of warnings, or null if there are none.
`boolean`	`hasErrors()` Returns true if there are any errors pending.
`boolean`	`hasWarnings()` Returns true if there are any warnings pending.
`void`	`write(PrintWriter writer, Janitor janitor)` Writes error messages to the specified PrintWriter.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - protected CompilerConfiguration configuration
    
    Configuration and other settings that control processing
  - protected LinkedList errors
    
    ErrorMessages collected during processing
  - protected LinkedList warnings
    
    WarningMessages collected during processing
- Constructor Detail
  - public ErrorCollector(CompilerConfiguration configuration)
    
    Initialize the ErrorReporter.
- Method Detail
  - public void addCollectorContents(ErrorCollector er)
  - public void addError(Message message)
    
    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.
  - public void addError(Message message, boolean fatal)
    
    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
  - public void addError(SyntaxException error, SourceUnit source)
    
    Convenience wrapper for addError().
  - public void addError(String text, CSTNode context, SourceUnit source)
    
    Convenience wrapper for addError().
  - public 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.
  - public void addException(Exception cause, SourceUnit source)
  - public void addFatalError(Message message)
    
    Adds a fatal exception to the message set and throws the unit as a PhaseFailedException.
  - public void addWarning(WarningMessage message)
    
    Adds a WarningMessage to the message set.
  - public void addWarning(int importance, String text, CSTNode context, SourceUnit source)
    
    Convenience wrapper for addWarning() that won't create an object unless it is relevant.
  - public void addWarning(int importance, String text, Object data, CSTNode context, SourceUnit source)
    
    Convenience wrapper for addWarning() that won't create an object unless it is relevant.
  - protected void failIfErrors()
    
    Causes the current phase to fail by throwing a CompilationFailedException.
  - public CompilerConfiguration getConfiguration()
    
    Returns:
    the compiler configuration used to create this error collector
  - public Message getError(int index)
    
    Returns the specified error message, or null.
  - public int getErrorCount()
    
    Returns the number of errors.
  - public List getErrors()
    
    Returns the list of errors, or null if there are none.
  - public Exception getException(int index)
    
    Convenience routine to return the specified error's underlying Exception, or null if it isn't one.
  - public Message getLastError()
    
    Returns the last error reported
  - public SyntaxException getSyntaxError(int index)
    
    Convenience routine to return the specified error's underlying SyntaxException, or null if it isn't one.
  - public WarningMessage getWarning(int index)
    
    Returns the specified warning message, or null.
  - public int getWarningCount()
    
    Returns the number of warnings.
  - public List getWarnings()
    
    Returns the list of warnings, or null if there are none.
  - public boolean hasErrors()
    
    Returns true if there are any errors pending.
  - public boolean hasWarnings()
    
    Returns true if there are any warnings pending.
  - public void write(PrintWriter writer, Janitor janitor)
    
    Writes error messages to the specified PrintWriter.

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class ErrorCollector

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected CompilerConfiguration configuration

protected LinkedList errors

protected LinkedList warnings

Constructor Detail

public ErrorCollector(CompilerConfiguration configuration)

Method Detail

public void addCollectorContents(ErrorCollector er)

public void addError(Message message)

public void addError(Message message, boolean fatal)

public void addError(SyntaxException error, SourceUnit source)

public void addError(String text, CSTNode context, SourceUnit source)

public void addErrorAndContinue(Message message)

public void addException(Exception cause, SourceUnit source)

public void addFatalError(Message message)

public void addWarning(WarningMessage message)

public void addWarning(int importance, String text, CSTNode context, SourceUnit source)

public void addWarning(int importance, String text, Object data, CSTNode context, SourceUnit source)

protected void failIfErrors()

public CompilerConfiguration getConfiguration()

public Message getError(int index)

public int getErrorCount()

public List getErrors()

public Exception getException(int index)

public Message getLastError()

public SyntaxException getSyntaxError(int index)

public WarningMessage getWarning(int index)

public int getWarningCount()

public List getWarnings()

public boolean hasErrors()

public boolean hasWarnings()

public void write(PrintWriter writer, Janitor janitor)