Package org.jenkinsci.plugins.tokenmacro.impl

Class BuildNumberMacro

java.lang.Object

org.jenkinsci.plugins.tokenmacro.TokenMacro

org.jenkinsci.plugins.tokenmacro.impl.BuildNumberMacro

All Implemented Interfaces:

ExtensionPoint

@Extension
public class BuildNumberMacro
extends TokenMacro

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static String	MACRO_NAME

Constructor Summary

Constructors

Constructor	Description
BuildNumberMacro()

Method Summary

Modifier and Type	Method	Description
boolean	acceptsMacroName(String macroName)	Returns true if this object can evaluate the macro of the given name.
String	evaluate(AbstractBuild<?,?> context, TaskListener listener, String macroName, Map<String,String> arguments, com.google.common.collect.ListMultimap<String,String> argumentMultimap)	Evaluates the macro and produces the token.
String	evaluate(Run<?,?> run, FilePath workspace, TaskListener listener, String macroName, Map<String,String> arguments, com.google.common.collect.ListMultimap<String,String> argumentMultimap)
List<String>	getAcceptedMacroNames()

Methods inherited from class org.jenkinsci.plugins.tokenmacro.TokenMacro

all, expand, expand, expand, expand, expandAll, expandAll, expandAll, expandAll, getAutoCompleteList, getPreviousRun, getWorkspace, hasNestedContent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MACRO_NAME

public static final String MACRO_NAME

See Also:

Constant Field Values

Constructor Detail

BuildNumberMacro

public BuildNumberMacro()

Method Detail

acceptsMacroName

public boolean acceptsMacroName(String macroName)

Description copied from class: TokenMacro

Returns true if this object can evaluate the macro of the given name.

Specified by:

acceptsMacroName in class TokenMacro

Parameters:

macroName - By convention we encourage all caps name.

Returns:

true ... to claim the macro of the given name and have TokenMacro.evaluate(AbstractBuild, TaskListener, String, Map, ListMultimap) called.

getAcceptedMacroNames

public List<String> getAcceptedMacroNames()

Overrides:

getAcceptedMacroNames in class TokenMacro

evaluate

public String evaluate(AbstractBuild<?,?> context,
                       TaskListener listener,
                       String macroName,
                       Map<String,String> arguments,
                       com.google.common.collect.ListMultimap<String,String> argumentMultimap)
                throws MacroEvaluationException,
                       IOException,
                       InterruptedException

Description copied from class: TokenMacro

Evaluates the macro and produces the token. If the token is to produce a human readable text, it should do so by using the implicit locale associated with the calling thread — see Functions.getCurrentLocale().

Specified by:

evaluate in class TokenMacro

Parameters:

context - The build object for which this macro is evaluated.

listener - If the progress/status needs to be reported to the build console output, this object can be used.

macroName - The macro name that you accepted

arguments - Arguments as a map. If multiple values are specified for one key, this will only retain the last one. This is passed in separately from argumentMultimap because

argumentMultimap - The same arguments, but in a multi-map. If multiple values are specified for one key, all of them are retained here in the order of appearance. For those macros that support multiple values for the same key this is more accurate than arguments, but it's bit more tedious to use.

Returns:

The result of the evaluation. Must not be null.

Throws:

MacroEvaluationException - If the evaluation failed, for example because of the parameter error, and that the error message should be presented.

IOException - Other fatal IOExceptions that should leave the stack trace in the console.

InterruptedException - If the evaluation involves some remoting operation, user might cancel the build, which results in an InterruptedException. Don't catch it, just propagate.

evaluate

public String evaluate(Run<?,?> run,
                       FilePath workspace,
                       TaskListener listener,
                       String macroName,
                       Map<String,String> arguments,
                       com.google.common.collect.ListMultimap<String,String> argumentMultimap)
                throws MacroEvaluationException,
                       IOException,
                       InterruptedException

Overrides:

evaluate in class TokenMacro

Throws:

MacroEvaluationException

IOException

InterruptedException