org.jenkinsci.plugins.tokenmacro.impl

Class EnvironmentVariableMacro

java.lang.Object

org.jenkinsci.plugins.tokenmacro.TokenMacro

org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro

org.jenkinsci.plugins.tokenmacro.impl.EnvironmentVariableMacro

All Implemented Interfaces:

hudson.ExtensionPoint

@Extension
public class EnvironmentVariableMacro
extends DataBoundTokenMacro

Token that expands variables from the build environment.

Nested Class Summary

Nested classes/interfaces inherited from class org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro

DataBoundTokenMacro.Parameter

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
String	var

Constructor Summary

Constructors

Constructor and Description
EnvironmentVariableMacro()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptsMacroName(String macroName) Returns true if this object can evaluate the macro of the given name.
String	evaluate(hudson.model.AbstractBuild<?,?> context, hudson.model.TaskListener listener, String macroName)

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

evaluate, hasNestedContent

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

all, expand, expand, expandAll, expandAll

Methods inherited from class java.lang.Object

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

Field Detail

var

public String var

Constructor Detail

EnvironmentVariableMacro

public EnvironmentVariableMacro()

Method Detail

evaluate

public String evaluate(hudson.model.AbstractBuild<?,?> context,
              hudson.model.TaskListener listener,
              String macroName)
                throws MacroEvaluationException,
                       IOException,
                       InterruptedException

Specified by:

evaluate in class DataBoundTokenMacro

Throws:

MacroEvaluationException

IOException

InterruptedException

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.