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.WorkspaceDependentMacro

org.jenkinsci.plugins.tokenmacro.impl.XmlFileMacro

All Implemented Interfaces:

ExtensionPoint

@Extension
public class XmlFileMacro
extends WorkspaceDependentMacro

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

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
String	file
static final Logger	LOGGER
String	xpath

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

escapeHtml

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(AbstractBuild<?,?> context, TaskListener listener, String macroName)
List<String>	getAcceptedMacroNames()
hudson.remoting.Callable<String,IOException>	getCallable(Run<?,?> run, String root, TaskListener listener)

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

evaluate

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

evaluate, evaluate, handlesHtmlEscapeInternally, 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 Details

LOGGER

public static final Logger LOGGER

file

public String file

xpath

public String xpath

Constructor Details

XmlFileMacro

public XmlFileMacro()

Method Details

acceptsMacroName

public boolean acceptsMacroName(String macroName)

Description copied from class: TokenMacro

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

Overrides:

acceptsMacroName in class WorkspaceDependentMacro

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)
                throws MacroEvaluationException,
IOException,
InterruptedException

Overrides:

evaluate in class WorkspaceDependentMacro

Throws:

MacroEvaluationException

IOException

InterruptedException

getCallable

public hudson.remoting.Callable<String,IOException> getCallable(Run<?,?> run,
 String root,
 TaskListener listener)

Specified by:

getCallable in class WorkspaceDependentMacro