Package de.monticore.generating.templateengine.reporting.reporter

Class HookPointReporter

java.lang.Object

de.monticore.generating.templateengine.reporting.commons.DefaultReportEventHandler

de.monticore.generating.templateengine.reporting.commons.AReporter

de.monticore.generating.templateengine.reporting.reporter.HookPointReporter

All Implemented Interfaces:

IReportEventHandler

public class HookPointReporter
extends AReporter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CALL_AFTER_TEMPLATE
static final String	CALL_BEFORE_TEMPLATE
static final String	CALL_HOOK_POINT
static final String	CALL_REPLACE_TEMPLATE
protected ReportingRepository	repository
static final String	SET_AFTER_TEMPLATE
static final String	SET_BEFORE_TEMPLATE
static final String	SET_HOOK_POINT
static final String	SET_REPLACE_TEMPLATE
static final String	SIMPLE_FILE_NAME

Fields inherited from class de.monticore.generating.templateengine.reporting.commons.AReporter

file, fileextension, fileOpen, qualifiedFileName, reportingHelper

Constructor Summary

Constructors

Constructor	Description
HookPointReporter(String outputDir, String modelName, ReportingRepository repository)

Method Summary

Modifier and Type	Method	Description
void	flush(ASTNode ast)	Method is called after generation.
protected String	getHookPointValue(HookPoint hp)
void	reportASTSpecificTemplateReplacement(String oldTemplate, ASTNode ast, HookPoint hp)
void	reportCallAfterHookPoint(String oldTemplate, Collection<HookPoint> afterHPs, ASTNode ast)
void	reportCallBeforeHookPoint(String oldTemplate, Collection<HookPoint> beforeHPs, ASTNode ast)
void	reportCallHookPointEnd(String hookName)
protected void	reportCallHookPointHelper(String oldTemplate, HookPoint hp, ASTNode ast, String shortcut)
void	reportCallHookPointStart(String hookName, HookPoint hp, ASTNode ast)
void	reportCallReplacementHookPoint(String oldTemplate, List<HookPoint> hps, ASTNode ast)
protected void	reportCallSpecificHookPointHelper(String oldTemplate, HookPoint hp, ASTNode ast)
void	reportCallSpecificReplacementHookPoint(String oldTemplate, List<HookPoint> hps, ASTNode ast)
void	reportSetAfterTemplate(String template, Optional<ASTNode> ast, List<? extends HookPoint> afterHps)
void	reportSetBeforeTemplate(String template, Optional<ASTNode> ast, List<? extends HookPoint> beforeHps)
void	reportSetHookPoint(String hookName, HookPoint hp)
protected void	reportSetHookPointHelper(String hookName, HookPoint hp, String shortcut)
protected void	reportSetTemplateHookpoint(String simpleTemplate, Optional<ASTNode> ast, HookPoint hp, String shortcut)
void	reportTemplateReplacement(String oldTemplate, List<? extends HookPoint> newHps)
protected void	writeFooter()
protected void	writeHeader()

Methods inherited from class de.monticore.generating.templateengine.reporting.commons.AReporter

closeFile, openFile, writeLine

Methods inherited from class de.monticore.generating.templateengine.reporting.commons.DefaultReportEventHandler

reportAddAfterTemplate, reportAddBeforeTemplate, reportAddValue, reportDetailed, reportError, reportErrorInternal, reportErrorUser, reportExecuteStandardTemplate, reportFileCreation, reportFileCreation, reportFileCreation, reportFileExistenceChecking, reportFileFinalization, reportHWCExistenceCheck, reportInstantiate, reportMethodCall, reportModelEnd, reportModelLoad, reportModelStart, reportOpenInputFile, reportOpenInputFile, reportParseInputFile, reportSetValue, reportSymbolTableScope, reportTemplateEnd, reportTemplateInclude, reportTemplateStart, reportTemplateWrite, reportTransformationNewValue, reportTransformationNewValue, reportTransformationNewValue, reportTransformationObjectChange, reportTransformationObjectCreation, reportTransformationObjectDeletion, reportTransformationObjectMatch, reportTransformationOldValue, reportTransformationOldValue, reportTransformationOldValue, reportTransformationStart, reportUseHandwrittenCodeFile, reportUserSpecificTemplate, reportUserWarning, reportWarning

Methods inherited from class java.lang.Object

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

Field Details

SET_HOOK_POINT

public static final String SET_HOOK_POINT

See Also:

• Constant Field Values

SET_REPLACE_TEMPLATE

public static final String SET_REPLACE_TEMPLATE

See Also:

• Constant Field Values

SET_BEFORE_TEMPLATE

public static final String SET_BEFORE_TEMPLATE

See Also:

• Constant Field Values

SET_AFTER_TEMPLATE

public static final String SET_AFTER_TEMPLATE

See Also:

• Constant Field Values

CALL_HOOK_POINT

public static final String CALL_HOOK_POINT

See Also:

• Constant Field Values

CALL_REPLACE_TEMPLATE

public static final String CALL_REPLACE_TEMPLATE

See Also:

• Constant Field Values

CALL_BEFORE_TEMPLATE

public static final String CALL_BEFORE_TEMPLATE

See Also:

• Constant Field Values

CALL_AFTER_TEMPLATE

public static final String CALL_AFTER_TEMPLATE

See Also:

• Constant Field Values

SIMPLE_FILE_NAME

public static final String SIMPLE_FILE_NAME

See Also:

• Constant Field Values

repository

protected ReportingRepository repository

Constructor Details

HookPointReporter

public HookPointReporter(String outputDir,
 String modelName,
 ReportingRepository repository)

Method Details

reportASTSpecificTemplateReplacement

public void reportASTSpecificTemplateReplacement(String oldTemplate,
 ASTNode ast,
 HookPoint hp)

Specified by:

reportASTSpecificTemplateReplacement in interface IReportEventHandler

Overrides:

reportASTSpecificTemplateReplacement in class DefaultReportEventHandler

Parameters:

oldTemplate -

ast -

hp -

reportSetHookPoint

public void reportSetHookPoint(String hookName,
 HookPoint hp)

Specified by:

reportSetHookPoint in interface IReportEventHandler

Overrides:

reportSetHookPoint in class DefaultReportEventHandler

Parameters:

hookName -

hp -

reportCallHookPointStart

public void reportCallHookPointStart(String hookName,
 HookPoint hp,
 ASTNode ast)

Specified by:

reportCallHookPointStart in interface IReportEventHandler

Overrides:

reportCallHookPointStart in class DefaultReportEventHandler

Parameters:

hookName -

hp -

ast -

reportCallAfterHookPoint

public void reportCallAfterHookPoint(String oldTemplate,
 Collection<HookPoint> afterHPs,
 ASTNode ast)

Specified by:

reportCallAfterHookPoint in interface IReportEventHandler

Overrides:

reportCallAfterHookPoint in class DefaultReportEventHandler

Parameters:

oldTemplate -

afterHPs -

ast -

See Also:

• DefaultReportEventHandler.reportCallAfterHookPoint(java.lang.String, java.util.Collection, de.monticore.ast.ASTNode)

reportCallBeforeHookPoint

public void reportCallBeforeHookPoint(String oldTemplate,
 Collection<HookPoint> beforeHPs,
 ASTNode ast)

Specified by:

reportCallBeforeHookPoint in interface IReportEventHandler

Overrides:

reportCallBeforeHookPoint in class DefaultReportEventHandler

Parameters:

oldTemplate -

beforeHPs -

ast -

See Also:

• DefaultReportEventHandler.reportCallBeforeHookPoint(java.lang.String, java.util.Collection, de.monticore.ast.ASTNode)

reportCallReplacementHookPoint

public void reportCallReplacementHookPoint(String oldTemplate,
 List<HookPoint> hps,
 ASTNode ast)

Specified by:

reportCallReplacementHookPoint in interface IReportEventHandler

Overrides:

reportCallReplacementHookPoint in class DefaultReportEventHandler

Parameters:

oldTemplate -

hps -

ast -

See Also:

• DefaultReportEventHandler.reportCallReplacementHookPoint(java.lang.String, java.util.List, de.monticore.ast.ASTNode)

reportCallSpecificReplacementHookPoint

public void reportCallSpecificReplacementHookPoint(String oldTemplate,
 List<HookPoint> hps,
 ASTNode ast)

Specified by:

reportCallSpecificReplacementHookPoint in interface IReportEventHandler

Overrides:

reportCallSpecificReplacementHookPoint in class DefaultReportEventHandler

Parameters:

oldTemplate -

hps -

ast -

See Also:

• DefaultReportEventHandler.reportCallSpecificReplacementHookPoint(java.lang.String, java.util.List, de.monticore.ast.ASTNode)

reportCallHookPointEnd

public void reportCallHookPointEnd(String hookName)

Specified by:

reportCallHookPointEnd in interface IReportEventHandler

Overrides:

reportCallHookPointEnd in class DefaultReportEventHandler

Parameters:

hookName -

See Also:

• DefaultReportEventHandler.reportCallHookPointEnd(java.lang.String)

reportTemplateReplacement

public void reportTemplateReplacement(String oldTemplate,
 List<? extends HookPoint> newHps)

Specified by:

reportTemplateReplacement in interface IReportEventHandler

Overrides:

reportTemplateReplacement in class DefaultReportEventHandler

Parameters:

oldTemplate -

newHps -

See Also:

• DefaultReportEventHandler.reportTemplateReplacement(java.lang.String, java.util.List)

reportSetBeforeTemplate

public void reportSetBeforeTemplate(String template,
 Optional<ASTNode> ast,
 List<? extends HookPoint> beforeHps)

Specified by:

reportSetBeforeTemplate in interface IReportEventHandler

Overrides:

reportSetBeforeTemplate in class DefaultReportEventHandler

Parameters:

template -

beforeHps -

See Also:

• DefaultReportEventHandler.reportSetBeforeTemplate(java.lang.String, Optional, java.util.List)

reportSetAfterTemplate

public void reportSetAfterTemplate(String template,
 Optional<ASTNode> ast,
 List<? extends HookPoint> afterHps)

Specified by:

reportSetAfterTemplate in interface IReportEventHandler

Overrides:

reportSetAfterTemplate in class DefaultReportEventHandler

Parameters:

template -

afterHps -

See Also:

• DefaultReportEventHandler.reportSetAfterTemplate(java.lang.String, Optional, java.util.List)

reportSetHookPointHelper

protected void reportSetHookPointHelper(String hookName,
 HookPoint hp,
 String shortcut)

reportSetTemplateHookpoint

protected void reportSetTemplateHookpoint(String simpleTemplate,
 Optional<ASTNode> ast,
 HookPoint hp,
 String shortcut)

reportCallHookPointHelper

protected void reportCallHookPointHelper(String oldTemplate,
 HookPoint hp,
 ASTNode ast,
 String shortcut)

reportCallSpecificHookPointHelper

protected void reportCallSpecificHookPointHelper(String oldTemplate,
 HookPoint hp,
 ASTNode ast)

getHookPointValue

protected String getHookPointValue(HookPoint hp)

flush

public void flush(ASTNode ast)

Description copied from class: AReporter

Method is called after generation.

Specified by:

flush in interface IReportEventHandler

Overrides:

flush in class AReporter

Parameters:

ast - Compilation unit AST or null on error

writeFooter

protected void writeFooter()

writeHeader

protected void writeHeader()

Specified by:

writeHeader in class AReporter