tech.harmonysoft.oss.traute.javac.log.AbstractLogger Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of traute-javac Show documentation

A Javac plugin which inserts null-checks into generated bytecode

There is a newer version: 1.1.10

package tech.harmonysoft.oss.traute.javac.log;

import org.jetbrains.annotations.NotNull;
import tech.harmonysoft.oss.traute.common.util.TrauteConstants;

public abstract class AbstractLogger implements TrautePluginLogger {

    /**
     * 
     *     There is a possible case that javac implementation is changed not in a backward compatible way in
     *     a new release. This plugin might stop working then (e.g. new approach should be used for fetching
     *     {@code AST} builder).
     * 
     * 
     *     We don't want to generate numerous errors for the compilation then but report at most once.
     * 
     * 
     *     This flag allows to check if a problem has already been reported.
     * 
     */
    private boolean problemReported;

    /**
     * Delegates to the {@link #report(String)} but adds more generic info to the given problem details
     *
     * @param problemDetails details of the problem to report
     */
    @Override
    public void reportDetails(@NotNull String problemDetails) {
        report(getProblemMessage(problemDetails));
    }

    /**
     * Shows given problem message to the end-user if necessary.
     *
     * @param message   a problem message to show
     */
    @Override
    public void report(@NotNull String message) {
        // Do not report a problem more than once
        if (!problemReported) {
            warn(message);
            problemReported = true;
        }
    }

    protected abstract void warn(@NotNull String message);

    @NotNull
    public abstract Object getKey();

    /**
     * Prepares a problem message to show end-user in case the plugin can't do the job during compilation.
     *
     * @param details   exact problem details, will be appended to the general problem description suffix
     * @return          a problem message to use
     */
    @NotNull
    public static String getProblemMessage(@NotNull String details) {
        return String.format(
                "NotNull-instrumentation failed, it might be that javac implementation has significantly changed "
                + "- '%s' javac plugin expected to %s. %s", TrauteConstants.PLUGIN_NAME, details, getProblemMessageSuffix()
        );
    }

    @NotNull
    public static String getProblemMessageSuffix() {
        return "Please contact the plugin's author via [email protected]";
    }
}