ProcessCodeGenericTask (code-augmentor-core 2.2.0 API)

java.lang.Object
- com.aaronicsubstances.code.augmentor.core.tasks.ProcessCodeGenericTask

```
public class ProcessCodeGenericTask
extends java.lang.Object
```
Implements processing stage of Code Augmentor. Intended for use by plugins and scripts written in Groovy (and other JVM languages).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ProcessCodeGenericTask.EvalFunction` Interface to code evaluation facility in JVM scripting language.
`static interface`	`ProcessCodeGenericTask.JsonParseFunction` Interface for scripts in JVM languages to parse JSON strings into objects relevant to their use cases.

Constructor Summary

Constructors
Constructor and Description

ProcessCodeGenericTask()

Constructors
Constructor and Description
`ProcessCodeGenericTask()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`execute(ProcessCodeGenericTask.EvalFunction evalFunction)` Executes processing stage of Code Augmentor.
`java.lang.String`	`generateStackTrace(java.lang.Throwable error)` Generate a stack trace for an error and all its nested exceptions, with any stack trace filters applied.
`java.util.function.Consumer<ProcessCodeContext>`	`getAfterAllFilesHook()`
`java.util.function.Consumer<ProcessCodeContext>`	`getAfterFileHook()`
`java.util.List<java.lang.Throwable>`	`getAllErrors()` Gets the error results of executing this task.
`java.util.function.Consumer<ProcessCodeContext>`	`getBeforeAllFilesHook()`
`java.util.function.Function<ProcessCodeContext,SourceFileGeneratedCode>`	`getBeforeFileHook()`
`java.io.File`	`getInputFile()` Gets the input file to read augmenting code objects from.
`ProcessCodeGenericTask.JsonParseFunction`	`getJsonParseFunction()`
`java.util.function.BiConsumer<GenericTaskLogLevel,java.util.function.Supplier<java.lang.String>>`	`getLogAppender()`
`java.io.File`	`getOutputFile()` Gets the output file to write generated code objects to.
`java.util.List<java.lang.String>`	`getStackTraceFilterPrefixes()`
`void`	`setAfterAllFilesHook(java.util.function.Consumer<ProcessCodeContext> afterAllFilesHook)` Sets an optional function which will be called once after all files have been processed.
`void`	`setAfterFileHook(java.util.function.Consumer<ProcessCodeContext> afterFileHook)` Sets an optional function which will be called every time a file processing of a file is completed, with or without errors.
`void`	`setBeforeAllFilesHook(java.util.function.Consumer<ProcessCodeContext> beforeAllFilesHook)` Sets an optional function which will be called once at the beginning, ie before any file is processed.
`void`	`setBeforeFileHook(java.util.function.Function<ProcessCodeContext,SourceFileGeneratedCode> beforeFileHook)` Sets an optional function which will be called every time a file is about to be processed.
`void`	`setInputFile(java.io.File inputFile)`
`void`	`setJsonParseFunction(ProcessCodeGenericTask.JsonParseFunction jsonParseFunction)` Sets the function object used to parse JSON strings into objects convenient for processing by a JVM language script.
`void`	`setLogAppender(java.util.function.BiConsumer<GenericTaskLogLevel,java.util.function.Supplier<java.lang.String>> logAppender)` Sets logging procedure for this task.
`void`	`setOutputFile(java.io.File outputFile)`
`void`	`setStackTraceFilterPrefixes(java.util.List<java.lang.String> stackTraceFilterPrefixes)` Sets an optional list of strings which will be used to filter out lines of a generated stack trace.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ProcessCodeGenericTask
```
public ProcessCodeGenericTask()
```
- Method Detail
  - execute
```
public void execute(ProcessCodeGenericTask.EvalFunction evalFunction)
             throws java.lang.Exception
```
    Executes processing stage of Code Augmentor. Augmenting code objects will be read from input file, passed to eval mechanism of a script, and the resulting generated code objects will be written out to output file.
    Success of this operation depends on emptiness of allErrors property.
    
    Parameters:
    
    evalFunction - interface to a JVM language's code evaluation facility.
    
    Throws:
    
    java.lang.Exception
  - generateStackTrace
```
public java.lang.String generateStackTrace(java.lang.Throwable error)
```
    Generate a stack trace for an error and all its nested exceptions, with any stack trace filters applied.
    
    Parameters:
    
    error -
    
    Returns:
  - 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
  - getInputFile
```
public java.io.File getInputFile()
```
    Gets the input file to read augmenting code objects from. Corresponds to AugCodeProcessingSpec.getDestFile()
    
    Returns:
    
    input file for task.
  - setInputFile
```
public void setInputFile(java.io.File inputFile)
```
  - getOutputFile
```
public java.io.File getOutputFile()
```
    Gets the output file to write generated code objects to. Corresponds to CodeAugmentationGenericTask.getGeneratedCodeFiles()
    
    Returns:
    
    output file of this task.
  - setOutputFile
```
public void setOutputFile(java.io.File outputFile)
```
  - getJsonParseFunction
```
public ProcessCodeGenericTask.JsonParseFunction getJsonParseFunction()
```
  - setJsonParseFunction
```
public void setJsonParseFunction(ProcessCodeGenericTask.JsonParseFunction jsonParseFunction)
```
    Sets the function object used to parse JSON strings into objects convenient for processing by a JVM language script.
    
    Parameters:
    
    jsonParseFunction -
  - getBeforeAllFilesHook
```
public java.util.function.Consumer<ProcessCodeContext> getBeforeAllFilesHook()
```
  - setBeforeAllFilesHook
```
public void setBeforeAllFilesHook(java.util.function.Consumer<ProcessCodeContext> beforeAllFilesHook)
```
    Sets an optional function which will be called once at the beginning, ie before any file is processed.
    
    Parameters:
    
    beforeAllFilesHook -
  - getAfterAllFilesHook
```
public java.util.function.Consumer<ProcessCodeContext> getAfterAllFilesHook()
```
  - setAfterAllFilesHook
```
public void setAfterAllFilesHook(java.util.function.Consumer<ProcessCodeContext> afterAllFilesHook)
```
    Sets an optional function which will be called once after all files have been processed. May not be called if any uncaught error occurs. All caught errors will be available in the allErrors property.
    
    Parameters:
    
    afterAllFilesHook -
  - getBeforeFileHook
```
public java.util.function.Function<ProcessCodeContext,SourceFileGeneratedCode> getBeforeFileHook()
```
  - setBeforeFileHook
```
public void setBeforeFileHook(java.util.function.Function<ProcessCodeContext,SourceFileGeneratedCode> beforeFileHook)
```
    Sets an optional function which will be called every time a file is about to be processed. This function can return a non-null object containing generated codes or marked for skipping later on during code detection. In any case a non-null object return from this function property is serialized directly to the output file, and bypasses the usual processing.
    
    Parameters:
    
    beforeFileHook -
  - getAfterFileHook
```
public java.util.function.Consumer<ProcessCodeContext> getAfterFileHook()
```
  - setAfterFileHook
```
public void setAfterFileHook(java.util.function.Consumer<ProcessCodeContext> afterFileHook)
```
    Sets an optional function which will be called every time a file processing of a file is completed, with or without errors.
    
    Parameters:
    
    afterFileHook -
  - getStackTraceFilterPrefixes
```
public java.util.List<java.lang.String> getStackTraceFilterPrefixes()
```
  - setStackTraceFilterPrefixes
```
public void setStackTraceFilterPrefixes(java.util.List<java.lang.String> stackTraceFilterPrefixes)
```
    Sets an optional list of strings which will be used to filter out lines of a generated stack trace.
    
    Parameters:
    
    stackTraceFilterPrefixes - lines of stack traces which begin with any item in an argument passed through this parameter will be omitted from stack trace.
  - 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.

Class ProcessCodeGenericTask

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProcessCodeGenericTask

Method Detail

execute

generateStackTrace

getLogAppender

setLogAppender

getInputFile

setInputFile

getOutputFile

setOutputFile

getJsonParseFunction

setJsonParseFunction

getBeforeAllFilesHook

setBeforeAllFilesHook

getAfterAllFilesHook

setAfterAllFilesHook

getBeforeFileHook

setBeforeFileHook

getAfterFileHook

setAfterFileHook

getStackTraceFilterPrefixes

setStackTraceFilterPrefixes

getAllErrors