com.aaronicsubstances.code.augmentor.core.tasks

Class PreCodeAugmentationGenericTask

java.lang.Object

com.aaronicsubstances.code.augmentor.core.tasks.PreCodeAugmentationGenericTask

public class PreCodeAugmentationGenericTask
extends java.lang.Object

Implements preparation stage of Code Augmentor, which is the first stage.

Constructor Summary

Constructors

Constructor and Description
PreCodeAugmentationGenericTask()

Method Summary

Modifier and Type	Method and Description
void	execute() Executes prepare stage of Code Augmentor.
java.util.List<java.lang.Throwable>	getAllErrors() Gets the error results of executing this task.
java.util.List<AugCodeProcessingSpec>	getAugCodeProcessingSpecs()
java.util.List<java.io.File>	getBaseDirs()
java.nio.charset.Charset	getCharset()
java.util.List<java.lang.String>	getEmbeddedJsonDirectives()
java.util.List<java.lang.String>	getEmbeddedStringDirectives()
java.util.List<java.lang.String>	getGenCodeEndDirectives()
java.util.List<java.lang.String>	getGenCodeStartDirectives()
java.util.List<java.lang.String>	getInlineGenCodeDirectives()
java.util.function.BiConsumer<GenericTaskLogLevel,java.util.function.Supplier<java.lang.String>>	getLogAppender()
java.util.List<java.lang.String>	getNestedLevelEndMarkers()
java.util.List<java.lang.String>	getNestedLevelStartMarkers()
java.io.File	getPrepFile()
java.util.List<java.lang.String>	getRelativePaths()
java.util.List<java.lang.String>	getSkipCodeEndDirectives()
java.util.List<java.lang.String>	getSkipCodeStartDirectives()
void	setAugCodeProcessingSpecs(java.util.List<AugCodeProcessingSpec> augCodeProcessingSpecs) Sets both augmenting code directives and the output file for storing the augmenting code associated with these directives.
void	setBaseDirs(java.util.List<java.io.File> baseDirs) Sets the directories of the source file sets which will be processed by this task.
void	setCharset(java.nio.charset.Charset charset) Sets the encoding of files which will be read and processed by this task.
void	setEmbeddedJsonDirectives(java.util.List<java.lang.String> embeddedJsonDirectives) This property defines embedded JSON directives for this task.
void	setEmbeddedStringDirectives(java.util.List<java.lang.String> embeddedStringDirectives) This property defines embedded string directives for this task.
void	setGenCodeEndDirectives(java.util.List<java.lang.String> genCodeEndDirectives) Defines generated code end directives for this task.
void	setGenCodeStartDirectives(java.util.List<java.lang.String> genCodeStartDirectives) This property defines generated code directives for this task.
void	setInlineGenCodeDirectives(java.util.List<java.lang.String> inlineGenCodeDirectives) This property defines for this task inline generated code directives.
void	setLogAppender(java.util.function.BiConsumer<GenericTaskLogLevel,java.util.function.Supplier<java.lang.String>> logAppender) Sets logging procedure for this task.
void	setNestedLevelEndMarkers(java.util.List<java.lang.String> nestedLevelEndMarkers) Sets the markers which this task uses to detect the end of nesting of augmenting code sections.
void	setNestedLevelStartMarkers(java.util.List<java.lang.String> nestedLevelStartMarkers) Sets the markers which this task will use to nest and assign nested levels to augmenting code sections.
void	setPrepFile(java.io.File prepFile) Sets the path of the prepFile output from this task.
void	setRelativePaths(java.util.List<java.lang.String> relativePaths) Sets the relative paths of the source files which will be processed by this task.
void	setSkipCodeEndDirectives(java.util.List<java.lang.String> skipCodeEndDirectives) Defines skip code end directives for this task.
void	setSkipCodeStartDirectives(java.util.List<java.lang.String> skipCodeEndDirectives) This property defines skip code start directives.

Methods inherited from class java.lang.Object

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

Constructor Detail

PreCodeAugmentationGenericTask

public PreCodeAugmentationGenericTask()

Method Detail

execute

public void execute()
             throws java.lang.Exception

Executes prepare stage of Code Augmentor. Upon successful completion prepFile will be created for use as input to the completion stage. Each AugCodeProcessingSpec.getDestFile() specified will be created for use as input to the processing stage.

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 -

getRelativePaths

public java.util.List<java.lang.String> getRelativePaths()

setRelativePaths

public void setRelativePaths(java.util.List<java.lang.String> relativePaths)

Sets the relative paths of the source files which will be processed by this task. Each path is relative to the entry in baseDirs property at the same index as the path here.

Parameters:

relativePaths - should be of the same size as baseDirs property.

getBaseDirs

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

setBaseDirs

public void setBaseDirs(java.util.List<java.io.File> baseDirs)

Sets the directories of the source file sets which will be processed by this task. The paths of the files in a directory entry of this property are specified by the entry in relativePaths property at the same index as the directory here.

Parameters:

baseDirs - should be of the same size as relativePaths property

getCharset

public java.nio.charset.Charset getCharset()

setCharset

public void setCharset(java.nio.charset.Charset charset)

Sets the encoding of files which will be read and processed by this task.

Parameters:

charset -

getPrepFile

public java.io.File getPrepFile()

setPrepFile

public void setPrepFile(java.io.File prepFile)

Sets the path of the prepFile output from this task. prepFile is currently not meant for consumption by library clients, as it contains data mostly of interest to the completion stage of Code Augmentor. It exists only because prepare stage is separated from completion stage by a processing stage. Thus library clients should just see this file as something to keep around during processing stage and just hand it over to completion stage.

Parameters:

prepFile -

getGenCodeStartDirectives

public java.util.List<java.lang.String> getGenCodeStartDirectives()

setGenCodeStartDirectives

public void setGenCodeStartDirectives(java.util.List<java.lang.String> genCodeStartDirectives)

This property defines generated code directives for this task. A generated code start directive is text which if found as a prefix of a line, indicates that the next line begins a generated code section. The generated code section will then have to end with a corresponding generated code end directive.

Parameters:

genCodeStartDirectives -

getGenCodeEndDirectives

public java.util.List<java.lang.String> getGenCodeEndDirectives()

setGenCodeEndDirectives

public void setGenCodeEndDirectives(java.util.List<java.lang.String> genCodeEndDirectives)

Defines generated code end directives for this task. Each directive is text which if found to start a line, will causes this task to consider the previous line as the last line of a generated code section.

Parameters:

genCodeEndDirectives -

See Also:

setGenCodeStartDirectives(List)

getEmbeddedStringDirectives

public java.util.List<java.lang.String> getEmbeddedStringDirectives()

setEmbeddedStringDirectives

public void setEmbeddedStringDirectives(java.util.List<java.lang.String> embeddedStringDirectives)

This property defines embedded string directives for this task. Inside an augmenting code section, directives can be used to specify that a portion of the augmenting code section is meant to be used a string by processing stage. Each directive is text which if found as the prefix of a line inside an augmenting code section, will cause this task to treat the remainder of line after the directive as an embedded string. A contiguous set of such lines will be treated together as one embedded string.

Parameters:

embeddedStringDirectives -

See Also:

setAugCodeProcessingSpecs(List)

getEmbeddedJsonDirectives

public java.util.List<java.lang.String> getEmbeddedJsonDirectives()

setEmbeddedJsonDirectives

public void setEmbeddedJsonDirectives(java.util.List<java.lang.String> embeddedJsonDirectives)

This property defines embedded JSON directives for this task. Inside an augmenting code section, directives can be used to specify that a portion of the augmenting code section is meant to be used a JSON value by processing stage. Each directive is text which if found as the prefix of a line inside an augmenting code section, will cause this task to treat the remainder of line after the directive as an embedded JSON value. A contiguous set of such lines will be treated together as one embedded JSON value.

Parameters:

embeddedJsonDirectives -

See Also:

setAugCodeProcessingSpecs(List)

getSkipCodeStartDirectives

public java.util.List<java.lang.String> getSkipCodeStartDirectives()

setSkipCodeStartDirectives

public void setSkipCodeStartDirectives(java.util.List<java.lang.String> skipCodeEndDirectives)

This property defines skip code start directives. Each directive is text which if found to start a line, will cause this task to skip processing augmenting code sections until a skip code end directive is encountered. This task uses this property to skip over sections of source file. Generated code sections will however not be skipped over, and so it is an error for generated and skip code sections to overlap.

Parameters:

skipCodeEndDirectives -

getSkipCodeEndDirectives

public java.util.List<java.lang.String> getSkipCodeEndDirectives()

setSkipCodeEndDirectives

public void setSkipCodeEndDirectives(java.util.List<java.lang.String> skipCodeEndDirectives)

Defines skip code end directives for this task. Each directive is text which if found to start a line, will causes this task to end skipping of source file lines, and begin parsing augmenting code sections again.

Parameters:

skipCodeEndDirectives -

See Also:

setSkipCodeStartDirectives(List)

getInlineGenCodeDirectives

public java.util.List<java.lang.String> getInlineGenCodeDirectives()

setInlineGenCodeDirectives

public void setInlineGenCodeDirectives(java.util.List<java.lang.String> inlineGenCodeDirectives)

This property defines for this task inline generated code directives. Each directive is text which if found to start a line, will cause this task to consider the remainder of the line after the text as a generated code section. Thus with this directive the number of lines needed to represent a generated code section can be reduced by 2 (no start/end directives), but on the other hand requires every inline generated code section to start with directive. A contiguous set of lines beginning with one of these directives will be treated by this task as a single generated code section.

Parameters:

inlineGenCodeDirectives -

getNestedLevelStartMarkers

public java.util.List<java.lang.String> getNestedLevelStartMarkers()

setNestedLevelStartMarkers

public void setNestedLevelStartMarkers(java.util.List<java.lang.String> nestedLevelStartMarkers)

Sets the markers which this task will use to nest and assign nested levels to augmenting code sections. Each marker is text which if found to follow an augmenting code directive (embedded string and JSON directives excluded), will cause this task to assign to subsequent augmenting code section 1 plus the nested level of the augmeting code section the marker was found in.

Nested level numbering start from 0. At the end of parsing a source file, appropriate nested level end markers must be used to end the nested level with 0 or an error occurs.

Parameters:

nestedLevelStartMarkers -

See Also:

setAugCodeProcessingSpecs(List)

getNestedLevelEndMarkers

public java.util.List<java.lang.String> getNestedLevelEndMarkers()

setNestedLevelEndMarkers

public void setNestedLevelEndMarkers(java.util.List<java.lang.String> nestedLevelEndMarkers)

Sets the markers which this task uses to detect the end of nesting of augmenting code sections. Each marker is text which if found to follow an augmenting code directive (embedded string and JSON excluded) will cause this task to decrease by 1 the nested level number it would otherwise have assigned to the augmenting code section the marker was found in. Subsequent augmenting code sections will be assigned the decreased nested level number.

Nested level numbers cannot be negative. It is therefore an error to encounter a nested level end marker when nested level number to be assigned is 0. That will mean that a corresponding nested level start marker was not previously seen.

Parameters:

nestedLevelEndMarkers -

See Also:

setAugCodeProcessingSpecs(List)

getAugCodeProcessingSpecs

public java.util.List<AugCodeProcessingSpec> getAugCodeProcessingSpecs()

setAugCodeProcessingSpecs

public void setAugCodeProcessingSpecs(java.util.List<AugCodeProcessingSpec> augCodeProcessingSpecs)

Sets both augmenting code directives and the output file for storing the augmenting code associated with these directives. Each directive is text which if found to start a line, will cause this task to take the remainder of the line after the directive as an augmenting code section. A contiguous set of lines starting with these directives, or embedded string/JSON directives will be treated as a single augmenting code section.

The data of an augmenting code section (remainders of lines with augmenting code directives or embedded string/JSON directives) are stored in files for use as input to the processing stage.

This property can be set with one or more output files to enable source files to have augmenting codes which are not all processed in the same way. For each output file, this task only writes to it augmenting code sections identified by the augmenting code directives that are assigned to that output file. Thus preparation stage can produce multiple files containing augmenting codes, and for that reason completion stage too can receive multiple files containing generated codes.

Parameters:

augCodeProcessingSpecs -

getAllErrors

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

Gets the error results of executing this task.

Returns:

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