com.aaronicsubstances.code.augmentor.core.tasks

Class CodeAugmentationGenericTask

java.lang.Object

com.aaronicsubstances.code.augmentor.core.tasks.CodeAugmentationGenericTask

public class CodeAugmentationGenericTask
extends java.lang.Object

Implements completion stage of Code Augmentor, which is the third and final stage.

If code changes are detected, then EFFECT-CHANGES OS shell script (in destination directory of generated files) can be run with -f option to bring source files up to date with generated files by overwritig them. Running EFFECT-CHANGES without any command line option brings help information on how to use the command.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHANGE_DETAILS_FILE_NAME Name of file used to store diff of generated files when code change detection is enabled.
static java.lang.String	CHANGE_SUMMARY_FILE_NAME Name of file used to store generated files when code change detection is enabled.
static java.lang.String	SHELL_SCRIPT_PREFIX Base name of OS shell script for viewing and making changes to source files in which code changes were detected.
static java.lang.String	WITHOUT_CHANGE_DETECTION_SUMMARY_FILE_NAME Name of file used to store generated files when code change detection is disabled.

Constructor Summary

Constructors

Constructor and Description
CodeAugmentationGenericTask()

Method Summary

Modifier and Type	Method and Description
void	execute() Runs completion stage.
java.util.List<java.lang.Throwable>	getAllErrors() Gets the error results of executing the task.
java.io.File	getChangeDetailsFile() Name of file with details of code changes detected in Unix diff normal format.
java.io.File	getChangeSummaryFile() If task was successfully executed, this property points to a file directly inside destination directory which contains listing of generated files and their corresponding files.
java.io.File	getDestDir()
java.util.List<java.io.File>	getGeneratedCodeFiles()
java.util.function.BiConsumer<GenericTaskLogLevel,java.util.function.Supplier<java.lang.String>>	getLogAppender()
java.io.File	getPrepFile()
boolean	isCodeChangeDetected() If code change detection is enabled, then this property informs on whether there were changes generated or not.
boolean	isCodeChangeDetectionDisabled()
void	setCodeChangeDetectionDisabled(boolean codeChangeDetectionDisabled) Sets whether or not code change detection should be disabled.
void	setDestDir(java.io.File destDir) Sets the destination directory for generated files.
void	setGeneratedCodeFiles(java.util.List<java.io.File> generatedCodeFiles) Sets the files with generated code in them which will be merged into source files passed to the prepare stage.
void	setLogAppender(java.util.function.BiConsumer<GenericTaskLogLevel,java.util.function.Supplier<java.lang.String>> logAppender) Sets logging procedure for this task.
void	setPrepFile(java.io.File prepFile) Sets this property with the prepFile output of the prepare stage.

Methods inherited from class java.lang.Object

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

Field Detail

CHANGE_SUMMARY_FILE_NAME

public static final java.lang.String CHANGE_SUMMARY_FILE_NAME

Name of file used to store generated files when code change detection is enabled.

See Also:

Constant Field Values

CHANGE_DETAILS_FILE_NAME

public static final java.lang.String CHANGE_DETAILS_FILE_NAME

Name of file used to store diff of generated files when code change detection is enabled.

See Also:

Constant Field Values

WITHOUT_CHANGE_DETECTION_SUMMARY_FILE_NAME

public static final java.lang.String WITHOUT_CHANGE_DETECTION_SUMMARY_FILE_NAME

Name of file used to store generated files when code change detection is disabled.

See Also:

Constant Field Values

SHELL_SCRIPT_PREFIX

public static final java.lang.String SHELL_SCRIPT_PREFIX

Base name of OS shell script for viewing and making changes to source files in which code changes were detected.

See Also:

Constant Field Values

Constructor Detail

CodeAugmentationGenericTask

public CodeAugmentationGenericTask()

Method Detail

execute

public void execute()
             throws java.lang.Exception

Runs completion stage. Will be successful only if allErrors property is empty after completion. If code change detection is enabled, then changeSummaryFile property will be used to store names of all files in which code changes were detected. Else changeSummaryFile property will be used to store all files except those for which all code generation requests were explicitly skipped.

Throws:

java.lang.Exception

getLogAppender

public java.util.function.BiConsumer<GenericTaskLogLevel,java.util.function.Supplier<java.lang.String>> getLogAppender()

setLogAppender

public void setLogAppender(java.util.function.BiConsumer<GenericTaskLogLevel,java.util.function.Supplier<java.lang.String>> logAppender)

Sets logging procedure for this task. By default this property is null, and so no logging is done.

Parameters:

logAppender - logging procedure or null for no logging

getPrepFile

public java.io.File getPrepFile()

setPrepFile

public void setPrepFile(java.io.File prepFile)

Sets this property with the prepFile output of the prepare stage.

Parameters:

prepFile -

See Also:

PreCodeAugmentationGenericTask.setPrepFile(File)

getGeneratedCodeFiles

public java.util.List<java.io.File> getGeneratedCodeFiles()

setGeneratedCodeFiles

public void setGeneratedCodeFiles(java.util.List<java.io.File> generatedCodeFiles)

Sets the files with generated code in them which will be merged into source files passed to the prepare stage. These are the output files from the processing stage.

Parameters:

generatedCodeFiles -

See Also:

ProcessCodeGenericTask.setOutputFile(File)

getDestDir

public java.io.File getDestDir()

setDestDir

public void setDestDir(java.io.File destDir)

Sets the destination directory for generated files. A folder will be created in this directory for each file set passed to the preparation stage.

If code change detection is disabled, then OUTPUT-SUMMARY.txt will be present. Else instead of OUTPUT-SUMMARY.txt, the following files will be present: CHANGE-SUMMARY.txt, CHANGE-DETAILS.txt, EFFECT-CHANGES

Parameters:

destDir -

isCodeChangeDetectionDisabled

public boolean isCodeChangeDetectionDisabled()

setCodeChangeDetectionDisabled

public void setCodeChangeDetectionDisabled(boolean codeChangeDetectionDisabled)

Sets whether or not code change detection should be disabled. By default code change detection is enabled (ie this property is false), and so a file will only be generated if they are going to be different from the corresponding source file. If this property is set to true, then all source files will have files generated for them, unless code generation for a source file is skipped.

Parameters:

codeChangeDetectionDisabled -

getAllErrors

public java.util.List<java.lang.Throwable> getAllErrors()

Gets the error results of executing the task.

Returns:

empty list if task execution was successful; non-empty list if task execution failed.

getChangeSummaryFile

public java.io.File getChangeSummaryFile()

If task was successfully executed, this property points to a file directly inside destination directory which contains listing of generated files and their corresponding files. Although readable by humans, it is more intended to be fed as input to OS shell scripts when code change detection is enabled, in order to overwrite source files and bring them up to date with generated files.

Returns:

file containing generated file paths.

getChangeDetailsFile

public java.io.File getChangeDetailsFile()

Name of file with details of code changes detected in Unix diff normal format.

Returns:

file with details of code changes or null if code change detection is disabled.

isCodeChangeDetected

public boolean isCodeChangeDetected()

If code change detection is enabled, then this property informs on whether there were changes generated or not.

Returns:

true if code change detection is enabled and changes were generated; false if code change detection is disabled, or there were no changed files.