com.aaronicsubstances.code.augmentor.core.tasks

Class ProcessCodeContext

java.lang.Object

com.aaronicsubstances.code.augmentor.core.tasks.ProcessCodeContext

public class ProcessCodeContext
extends java.lang.Object

Helper context object intended for use by scripts written in Groovy (and other JVM languages) during processing stage of Code Augmentor.

Constructor Summary

Constructors

Constructor and Description
ProcessCodeContext(java.util.function.BiConsumer<java.lang.String,java.lang.Throwable> errorAccumulator)

Method Summary

Modifier and Type	Method and Description
void	addError(java.lang.String message, java.lang.Throwable cause) Available for accumulating all errors that may occur during the lifetime of instance of this class.
int	getAugCodeIndex() Gets the index of the augmenting code currently being processed.
SourceFileAugmentingCode	getFileAugCodes() Gets all of the augmenting code objects for the file currently being processed.
java.util.Map<java.lang.String,java.lang.Object>	getFileScope() Returns readonly map for use by JVM language script during processing stage to record objects for a file of augmenting code objects for script's own purposes.
java.util.Map<java.lang.String,java.lang.Object>	getGlobalScope() Returns readonly map for use by JVM language script during processing stage to record global objects for its own purposes.
java.lang.Object	getHeader() Returns result of parsing the header (ie first line) of the files returned by preparation stage as aug code files and presented separately to processing stage as input files.
java.lang.Object	getScopeVar(java.lang.String name) Gets a variable from file or global scopes, with preference for file scope.
java.io.File	getSrcFile() Gets the file of augmenting code objects currently being processed.
GeneratedCode.ContentPart	newContent(java.lang.String content) Creates a new content part with inexact matching.
GeneratedCode.ContentPart	newContent(java.lang.String content, boolean exactMatch) Creates a new content part.
GeneratedCode	newGenCode() Creates a new GeneratedCode with an empty modifiable list of content parts.
GeneratedCode	newSkipGenCode() Creates a new GeneratedCode with skipped property set to true and null content parts.
void	setHeader(java.lang.Object header)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessCodeContext

public ProcessCodeContext(java.util.function.BiConsumer<java.lang.String,java.lang.Throwable> errorAccumulator)

Method Detail

newGenCode

public GeneratedCode newGenCode()

Creates a new GeneratedCode with an empty modifiable list of content parts.

Returns:

new generated code object.

newSkipGenCode

public GeneratedCode newSkipGenCode()

Creates a new GeneratedCode with skipped property set to true and null content parts.

Returns:

new generated code object for skipping aug code section during completion stage.

newContent

public GeneratedCode.ContentPart newContent(java.lang.String content)

Creates a new content part with inexact matching.

Parameters:

content - string of content part

Returns:

new content part with inexact matching.

newContent

public GeneratedCode.ContentPart newContent(java.lang.String content,
                                            boolean exactMatch)

Creates a new content part.

Parameters:

content - string of content part.

exactMatch - true to match string exactly and disallow insertion of indentation; false to admit insertion of leading indents.

Returns:

new content part.

getHeader

public java.lang.Object getHeader()

Returns result of parsing the header (ie first line) of the files returned by preparation stage as aug code files and presented separately to processing stage as input files.

Returns:

parsed header from input file to processing stage.

setHeader

public void setHeader(java.lang.Object header)

getGlobalScope

public java.util.Map<java.lang.String,java.lang.Object> getGlobalScope()

Returns readonly map for use by JVM language script during processing stage to record global objects for its own purposes. Contents of this map stay put throughout processing stage.

Returns:

global scope dictionary.

getFileScope

public java.util.Map<java.lang.String,java.lang.Object> getFileScope()

Returns readonly map for use by JVM language script during processing stage to record objects for a file of augmenting code objects for script's own purposes. Unlike global scope, contents of this map only stay put throughout processing of current file of augmenting code objects, and then when a new file is encountered, the dictionary is emptied of its contents.

Returns:

dictionary scoped to file of augmenting code objects.

getFileAugCodes

public SourceFileAugmentingCode getFileAugCodes()

Gets all of the augmenting code objects for the file currently being processed.

Returns:

current file's augmenting code object array.

getAugCodeIndex

public int getAugCodeIndex()

Gets the index of the augmenting code currently being processed. That is, index into the augmenting code object array of the file currently being processed.

Returns:

index of current augmenting code object.

getSrcFile

public java.io.File getSrcFile()

Gets the file of augmenting code objects currently being processed.

Returns:

current file of augmenting codes.

addError

public void addError(java.lang.String message,
                     java.lang.Throwable cause)

Available for accumulating all errors that may occur during the lifetime of instance of this class.

getScopeVar

public java.lang.Object getScopeVar(java.lang.String name)

Gets a variable from file or global scopes, with preference for file scope.

Parameters:

name - variable name

Returns:

variable value in file scope first, or in global scope.