org.jactr.io.compiler

Class AbstractReportableUnitCompiler

java.lang.Object

org.jactr.io.compiler.AbstractReportableUnitCompiler

All Implemented Interfaces:

IReportableUnitCompiler, IUnitCompiler

Direct Known Subclasses:

StrictHarvestingUnitCompiler

public abstract class AbstractReportableUnitCompiler
extends java.lang.Object
implements IReportableUnitCompiler

basic abstract IReportableUnitCompiler. Clients should extend and implement compile(CommonTree) from which you will call report(String, CommonTree) with any messages. The actual message and its reporting back to the DefaultCompiler will be handled based on IReportableUnitCompiler.Level.

This class is not thread safe.

Author:

harrison

Nested Class Summary

Nested classes/interfaces inherited from interface org.jactr.io.compiler.IReportableUnitCompiler

IReportableUnitCompiler.Level

Constructor Summary

Constructors

Constructor and Description
AbstractReportableUnitCompiler()

Method Summary

Modifier and Type	Method and Description
protected abstract void	compile(org.antlr.runtime.tree.CommonTree node) do the actual compilation checks.
void	compile(org.antlr.runtime.tree.CommonTree node, java.util.Collection<java.lang.Exception> info, java.util.Collection<java.lang.Exception> warnings, java.util.Collection<java.lang.Exception> errors)
protected java.util.Collection<java.lang.Exception>	getCollection(IReportableUnitCompiler.Level level)
java.util.Collection<java.lang.Integer>	getRelevantTypes() return a collection of JACTRBuilder.
IReportableUnitCompiler.Level	getReportLevel()
void	postCompile() noop
void	preCompile() noop
protected java.lang.Exception	report(java.lang.String message, org.antlr.runtime.tree.CommonTree node)
protected CommonTreeException	report(java.lang.String message, org.antlr.runtime.tree.CommonTree node, java.lang.Throwable thrown)
protected void	setRelevantTypes(java.lang.Integer... types)
void	setReportLevel(IReportableUnitCompiler.Level level)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractReportableUnitCompiler

public AbstractReportableUnitCompiler()

Method Detail

setRelevantTypes

protected void setRelevantTypes(java.lang.Integer... types)

getRelevantTypes

public final java.util.Collection<java.lang.Integer> getRelevantTypes()

Description copied from interface: IUnitCompiler

return a collection of JACTRBuilder. types that this unit compiler is interested in

Specified by:

getRelevantTypes in interface IUnitCompiler

Returns:

getReportLevel

public IReportableUnitCompiler.Level getReportLevel()

Specified by:

getReportLevel in interface IReportableUnitCompiler

setReportLevel

public void setReportLevel(IReportableUnitCompiler.Level level)

Specified by:

setReportLevel in interface IReportableUnitCompiler

compile

public final void compile(org.antlr.runtime.tree.CommonTree node,
                          java.util.Collection<java.lang.Exception> info,
                          java.util.Collection<java.lang.Exception> warnings,
                          java.util.Collection<java.lang.Exception> errors)

Specified by:

compile in interface IUnitCompiler

report

protected java.lang.Exception report(java.lang.String message,
                                     org.antlr.runtime.tree.CommonTree node)

report

protected CommonTreeException report(java.lang.String message,
                                     org.antlr.runtime.tree.CommonTree node,
                                     java.lang.Throwable thrown)

getCollection

protected java.util.Collection<java.lang.Exception> getCollection(IReportableUnitCompiler.Level level)

compile

protected abstract void compile(org.antlr.runtime.tree.CommonTree node)

do the actual compilation checks. the reporting of any issues should be done via report(String, CommonTree), which will format the appropriate message and store it in the correct collection.

Parameters:

node -

postCompile

public void postCompile()

noop

Specified by:

postCompile in interface IUnitCompiler

See Also:

IUnitCompiler.postCompile()

preCompile

public void preCompile()

noop

Specified by:

preCompile in interface IUnitCompiler

See Also:

IUnitCompiler.preCompile()