1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

package Torello.Java.Build;

import java.io.IOException;

/**
 * The Function-Pointer Interface used with the Stage-3 Upgrader "Pre" and "Post" Processors.
 */
@FunctionalInterface
public interface UpgradeProcessor extends java.io.Serializable
{
    /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUIDFI>  */
    public static final long serialVersionUID = 1;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=FUNC_INTER_METH>
     *
     * <BR /><BR />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 {@link Builder} instance using the {@link Config} Configuration-Class fields: 
     * {@link Config#preUpgraderScript preUpgraderScript} and
     * {@link Config#postUpgraderScript postUpgraderScript}
     * 
     * @param builder Provided to this method by the Build-Mechanism for convienence.  This class
     * contains many public constant-fields.
     * 
     * @param logOutput May be used to print any output or log data
     * 
     * @throws IOException {@code IOException} is very common during the build, and if it is thrown
     * it will printed
     */
    public void accept(Builder builder, StringBuilder logOutput) throws IOException;
}