hudson.plugins.analysis.tokens.AbstractTokenMacro Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of analysis-core Show documentation

This plug-in provides utilities for the static code analysis plug-ins.

The newest version!

package hudson.plugins.analysis.tokens;

import java.io.IOException;

import org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro;
import org.jenkinsci.plugins.tokenmacro.MacroEvaluationException;

import hudson.model.TaskListener;
import hudson.model.AbstractBuild;

import hudson.plugins.analysis.core.BuildResult;
import hudson.plugins.analysis.core.ResultAction;

/**
 * Provides a token that evaluates to the plug-in build result.
 *
 * @author Ulli Hafner
 */
public abstract class AbstractTokenMacro extends DataBoundTokenMacro {
    private final Class>[] resultActions;
    private final String tokenName;

    /**
     * Creates a new instance of {@link AbstractTokenMacro}.
     *
     * @param tokenName
     *            the name of the token
     * @param resultActions
     *            associated action types containing the build result
     */
    public AbstractTokenMacro(final String tokenName,
            final Class>... resultActions) {
        super();

        this.resultActions = resultActions;
        this.tokenName = tokenName;
    }

    @Override
    public String evaluate(final AbstractBuild context, final TaskListener listener, final String macroName)
            throws MacroEvaluationException, IOException, InterruptedException {
        for (Class> resultActionType : resultActions) {
            ResultAction action = context.getAction(resultActionType);
            if (action != null) {
                return evaluate(action.getResult());
            }
        }
        return "";
    }

    /**
     * Evaluates the build result and returns the string value of the token.
     *
     * @param result
     *            the result to evaluate
     * @return the string value of the token
     */
    protected abstract String evaluate(final BuildResult result);

    @Override
    public boolean acceptsMacroName(final String macroName) {
        return tokenName.equals(macroName);
    }
}