Package net.officefloor.compile.issues

Interface SourceIssues

All Known Subinterfaces:

ManagedFunctionAugmentorContext, ManagedObjectSourceAugmentorContext, OfficeArchitect, OfficeFloorDeployer, OfficeFloorNode, OfficeNode, SectionDesigner, SectionNode, TeamAugmentorContext

All Known Implementing Classes:

OfficeFloorNodeImpl, OfficeNodeImpl, SectionNodeImpl, TransformSectionDesigner, WebTemplateLoaderImpl

public interface SourceIssues

Provides means to raise CompilerIssue.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
CompileError	addIssue(java.lang.String issueDescription)	Allows the source to add an issue.
CompileError	addIssue(java.lang.String issueDescription, java.lang.Throwable cause)	Allows the source to add an issue along with its cause.

Method Detail

addIssue

CompileError addIssue(java.lang.String issueDescription)

Allows the source to add an issue.

This is available to report invalid configuration.

Parameters:

issueDescription - Description of the issue.

Returns:

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

addIssue

CompileError addIssue(java.lang.String issueDescription,
                      java.lang.Throwable cause)

Allows the source to add an issue along with its cause.

This is available to report invalid configuration.

Parameters:

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.