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

Class InvolvedFilesReporter

java.lang.Object

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

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

de.monticore.generating.templateengine.reporting.reporter.InvolvedFilesReporter

All Implemented Interfaces:

IReportEventHandler

public class InvolvedFilesReporter
extends AReporter

It reports the name of all input and output files as well as the name of files which existence was checked.

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	checkedFiles
static final String	EOF
static final String	HWC_FILE_HEADING
static final String	INDENT
static final String	INPUT_FILE_HEADING
static final String	INPUT_FILES_HEADING
protected Optional<String>	inputFile
protected List<String>	inputFiles
protected Map<Path,Path>	modelToArtifactMap
static final String	OUTPUT_FILE_HEADING
protected String	outputDirectory
protected List<String>	outputFiles
static final String	PARENT_FILE_SEPARATOR
protected Optional<Path>	qualifiedInputFile
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
InvolvedFilesReporter(String outputDir)	Constructor for de.monticore.generating.templateengine.reporting.reporter.

Method Summary

Modifier and Type	Method	Description
void	flush(ASTNode ast)	Method is called after generation.
protected String	format(String fileName)
void	reportFileCreation(String fileName)
void	reportOpenInputFile(String fileName)
void	reportOpenInputFile(Optional<Path> parentPath, Path file)
void	reportParseInputFile(Path inputFilePath, String modelName)
void	reportUseHandwrittenCodeFile(Path parentDir, Path fileName)
protected void	writeContent()
protected void	writeFooter()
protected void	writeHeader()
protected void	writeHWCFileHeading()
protected void	writeInputFileHeading()
protected void	writeInputFilesHeading()
protected void	writeOutputFileHeading()

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, reportASTSpecificTemplateReplacement, reportCallAfterHookPoint, reportCallBeforeHookPoint, reportCallHookPointEnd, reportCallHookPointStart, reportCallReplacementHookPoint, reportCallSpecificReplacementHookPoint, reportDetailed, reportError, reportErrorInternal, reportErrorUser, reportExecuteStandardTemplate, reportFileCreation, reportFileCreation, reportFileExistenceChecking, reportFileFinalization, reportHWCExistenceCheck, reportInstantiate, reportMethodCall, reportModelEnd, reportModelLoad, reportModelStart, reportSetAfterTemplate, reportSetBeforeTemplate, reportSetHookPoint, reportSetValue, reportSymbolTableScope, reportTemplateEnd, reportTemplateInclude, reportTemplateReplacement, reportTemplateStart, reportTemplateWrite, reportTransformationNewValue, reportTransformationNewValue, reportTransformationNewValue, reportTransformationObjectChange, reportTransformationObjectCreation, reportTransformationObjectDeletion, reportTransformationObjectMatch, reportTransformationOldValue, reportTransformationOldValue, reportTransformationOldValue, reportTransformationStart, reportUserSpecificTemplate, reportUserWarning, reportWarning

Methods inherited from class java.lang.Object

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

Field Details

SIMPLE_FILE_NAME

public static final String SIMPLE_FILE_NAME

See Also:

• Constant Field Values

INDENT

public static final String INDENT

PARENT_FILE_SEPARATOR

public static final String PARENT_FILE_SEPARATOR

See Also:

• Constant Field Values

inputFiles

protected List<String> inputFiles

outputFiles

protected List<String> outputFiles

checkedFiles

protected Set<String> checkedFiles

modelToArtifactMap

protected Map<Path,Path> modelToArtifactMap

outputDirectory

protected String outputDirectory

inputFile

protected Optional<String> inputFile

qualifiedInputFile

protected Optional<Path> qualifiedInputFile

INPUT_FILE_HEADING

public static final String INPUT_FILE_HEADING

See Also:

• Constant Field Values

INPUT_FILES_HEADING

public static final String INPUT_FILES_HEADING

See Also:

• Constant Field Values

OUTPUT_FILE_HEADING

public static final String OUTPUT_FILE_HEADING

See Also:

• Constant Field Values

HWC_FILE_HEADING

public static final String HWC_FILE_HEADING

See Also:

• Constant Field Values

EOF

public static final String EOF

See Also:

• Constant Field Values

Constructor Details

InvolvedFilesReporter

public InvolvedFilesReporter(String outputDir)

Constructor for de.monticore.generating.templateengine.reporting.reporter. FilesReporter

Parameters:

outputDir -

Method Details

writeInputFileHeading

protected void writeInputFileHeading()

writeInputFilesHeading

protected void writeInputFilesHeading()

writeOutputFileHeading

protected void writeOutputFileHeading()

writeHWCFileHeading

protected void writeHWCFileHeading()

writeFooter

protected void writeFooter()

reportFileCreation

public void reportFileCreation(String fileName)

Specified by:

reportFileCreation in interface IReportEventHandler

Overrides:

reportFileCreation in class DefaultReportEventHandler

reportUseHandwrittenCodeFile

public void reportUseHandwrittenCodeFile(Path parentDir,
 Path fileName)

Specified by:

reportUseHandwrittenCodeFile in interface IReportEventHandler

Overrides:

reportUseHandwrittenCodeFile in class DefaultReportEventHandler

Parameters:

fileName -

reportOpenInputFile

public void reportOpenInputFile(Optional<Path> parentPath,
 Path file)

Specified by:

reportOpenInputFile in interface IReportEventHandler

Overrides:

reportOpenInputFile in class DefaultReportEventHandler

reportOpenInputFile

public void reportOpenInputFile(String fileName)

Specified by:

reportOpenInputFile in interface IReportEventHandler

Overrides:

reportOpenInputFile in class DefaultReportEventHandler

reportParseInputFile

public void reportParseInputFile(Path inputFilePath,
 String modelName)

Specified by:

reportParseInputFile in interface IReportEventHandler

Overrides:

reportParseInputFile in class DefaultReportEventHandler

See Also:

• DefaultReportEventHandler.reportParseInputFile(java.nio.file.Path, java.lang.String)

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

writeHeader

protected void writeHeader()

Specified by:

writeHeader in class AReporter

format

protected String format(String fileName)

writeContent

protected void writeContent()