Package Torello.Java.Build

Interface UpgradeProcessor

All Superinterfaces:

java.io.Serializable

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface UpgradeProcessor
extends java.io.Serializable

The Function-Pointer Interface used with the Stage-3 Upgrader "Pre" and "Post" Processors.

Hi-Lited Source-Code:

• View Here: Torello/Java/Build/UpgradeProcessor.java
• Open New Browser-Tab: Torello/Java/Build/UpgradeProcessor.java

File Size: 1,306 Bytes Line Count: 32 '\n' Characters Found

Field Summary

Fields

Modifier and Type	Field
static long	serialVersionUID

Method Summary

@FunctionalInterface: (Lambda) Method
Modifier and Type	Method
void	accept(Builder builder, StringBuilder logOutput)

Field Detail

serialVersionUID

🡇 ⇈ ⮫ 🗕 🗗 🗖

static final long serialVersionUID

This fulfils the SerialVersion UID requirement for all classes that implement Java's interface java.io.Serializable. Using the Serializable Implementation offered by java is very easy, and can make saving program state when debugging a lot easier. It can also be used in place of more complicated systems like "hibernate" to store data as well.

Functional Interfaces are usually not thought of as Data Objects that need to be saved, stored and retrieved; however, having the ability to store intermediate results along with the lambda-functions that helped get those results can make debugging easier.

See Also:

Constant Field Values

Code:

Exact Field Declaration Expression:

 public static final long serialVersionUID = 1;

Method Detail

accept

🡅 ⇈ ⮫ 🗕 🗗 🗖

void accept(Builder builder,
            java.lang.StringBuilder logOutput)
     throws java.io.IOException

FunctionalInterface Target-Method:
This method corresponds to the @FunctionalInterface Annotation's method requirement. It is the only non-default, non-static method in this interface, and may be the target of a Lambda-Expression or '::' (double-colon) Function-Pointer.

May be used to implement any kind of pre-processing or post-processing during the "Stage 3" - Java-Doc Upgrader Stage. Pass any Lambda-Expression or Function-Pointer to to the Builder instance using the Config Configuration-Class fields: preUpgraderScript and postUpgraderScript

Parameters:

builder - Provided to this method by the Build-Mechanism for convienence. This class contains many public constant-fields.

logOutput - May be used to print any output or log data

Throws:

java.io.IOException - IOException is very common during the build, and if it is thrown it will printed