Package org.jenkinsci.plugins.tokenmacro.impl

Class XmlFileMacro

java.lang.Object

org.jenkinsci.plugins.tokenmacro.TokenMacro

org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro

org.jenkinsci.plugins.tokenmacro.impl.XmlFileMacro

All Implemented Interfaces:

hudson.ExtensionPoint

@Extension
public class XmlFileMacro
extends DataBoundTokenMacro

Expands to a xml value(s) from a xml file relative to the workspace root. If xpath evaluates to more than one value then a semicolon separted string is returned.

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	Description
String	file
static Logger	LOGGER
String	xpath

Constructor Summary

Constructors

Constructor	Description
XmlFileMacro()

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(hudson.model.AbstractBuild<?,?> context, hudson.model.TaskListener listener, String macroName)
String	evaluate(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.model.TaskListener listener, String macroName)
List<String>	getAcceptedMacroNames()

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

evaluate, evaluate, hasNestedContent

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

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

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

public static final Logger LOGGER

file

public String file

xpath

public String xpath

Constructor Detail

XmlFileMacro

public XmlFileMacro()

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(hudson.model.AbstractBuild<?,?> context,
                       hudson.model.TaskListener listener,
                       String macroName)
                throws MacroEvaluationException,
                       IOException,
                       InterruptedException

Specified by:

evaluate in class DataBoundTokenMacro

Throws:

MacroEvaluationException

IOException

InterruptedException

evaluate

public String evaluate(hudson.model.Run<?,?> run,
                       hudson.FilePath workspace,
                       hudson.model.TaskListener listener,
                       String macroName)
                throws MacroEvaluationException,
                       IOException,
                       InterruptedException

Overrides:

evaluate in class DataBoundTokenMacro

Throws:

MacroEvaluationException

IOException

InterruptedException