Package net.officefloor.compile.impl.issues

Class AbstractCompilerIssues

java.lang.Object

net.officefloor.compile.impl.issues.AbstractCompilerIssues

All Implemented Interfaces:

CompilerIssues

Direct Known Subclasses:

FailCompilerIssues, FailTestCompilerIssues, StderrCompilerIssues

public abstract class AbstractCompilerIssues
extends Object
implements CompilerIssues

Abstract CompilerIssues

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
AbstractCompilerIssues()

Method Summary

Modifier and Type	Method	Description
CompileError	addIssue(Node node, String issueDescription, Throwable cause)	Adds an issue regarding a particular Node.
CompileError	addIssue(Node node, String issueDescription, CompilerIssue... causes)	Adds an issue regarding a particular Node.
<R> IssueCapture<R>	captureIssues(Supplier<R> supplier)	Captures CompilerIssue instances.
protected CompilerIssue	createCompilerIssue(Node node, String issueDescription, Throwable cause, CompilerIssue[] causes)	Creates the CompilerIssue for use in abstract functionality.
protected abstract void	handleDefaultIssue(DefaultCompilerIssue issue)	Implement to handle DefaultCompilerIssue.
protected void	handleIssue(CompilerIssue issue)	Override to handle the CompilerIssue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractCompilerIssues

public AbstractCompilerIssues()

Method Details

handleIssue

protected void handleIssue(CompilerIssue issue)

Override to handle the CompilerIssue.

Parameters:

issue - CompilerIssue.

handleDefaultIssue

protected abstract void handleDefaultIssue(DefaultCompilerIssue issue)

Implement to handle DefaultCompilerIssue.

Parameters:

issue - DefaultCompilerIssue.

captureIssues

public <R> IssueCapture<R> captureIssues(Supplier<R> supplier)

Description copied from interface: CompilerIssues

Captures CompilerIssue instances.

Specified by:

captureIssues in interface CompilerIssues

Type Parameters:

R - Return type of Supplier logic.

Parameters:

supplier - Supplier of code to capture CompilerIssue within.

Returns:

IssueCapture.

addIssue

public CompileError addIssue(Node node,
 String issueDescription,
 CompilerIssue... causes)

Description copied from interface: CompilerIssues

Adds an issue regarding a particular Node.

Specified by:

addIssue in interface CompilerIssues

Parameters:

node - Node.

issueDescription - Description of the issue.

causes - Possible CompilerIssue instances causing this issue.

Returns:

CompileError to be used in throw statement when adding CompilerIssue to avoid further compiling of the Node.

addIssue

public CompileError addIssue(Node node,
 String issueDescription,
 Throwable cause)

Description copied from interface: CompilerIssues

Adds an issue regarding a particular Node.

Specified by:

addIssue in interface CompilerIssues

Parameters:

node - Node.

issueDescription - Description of the issue.

cause - Cause of the issue.

Returns:

CompileError to be used in throw statement when adding CompilerIssue to avoid further compiling of the Node.

createCompilerIssue

protected CompilerIssue createCompilerIssue(Node node,
 String issueDescription,
 Throwable cause,
 CompilerIssue[] causes)

Creates the CompilerIssue for use in abstract functionality. If not overriden, a DefaultCompilerIssue is used.

Parameters:

node - Node.

issueDescription - Issue description.

cause - Optional cause. May be null.

causes - Optional cause CompilerIssue instances.

Returns:

CompilerIssue, with default implementation providing a DefaultCompilerIssue.