org.jenkinsci.plugins.tokenmacro.impl

Class WorkspaceFileMacro

java.lang.Object

org.jenkinsci.plugins.tokenmacro.TokenMacro

org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro

org.jenkinsci.plugins.tokenmacro.impl.WorkspaceFileMacro

All Implemented Interfaces:

hudson.ExtensionPoint

@Extension
public class WorkspaceFileMacro
extends DataBoundTokenMacro

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	fileNotFoundMessage
static String	MACRO_NAME
String	path

Constructor Summary

Constructors

Constructor and Description
WorkspaceFileMacro()

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)
boolean	hasNestedContent() Returns true if this object allows for nested content replacements.

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

evaluate

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

all, expand, expand, expandAll, expandAll, getWorkspace

Methods inherited from class java.lang.Object

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

Field Detail

path

public String path

fileNotFoundMessage

public String fileNotFoundMessage

MACRO_NAME

public static final String MACRO_NAME

See Also:

Constant Field Values

Constructor Detail

WorkspaceFileMacro

public WorkspaceFileMacro()

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.

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

hasNestedContent

public boolean hasNestedContent()

Description copied from class: TokenMacro

Returns true if this object allows for nested content replacements.

Overrides:

hasNestedContent in class DataBoundTokenMacro

Returns:

true ... to have the replaced text passed again to TokenMacro.expand(AbstractBuild, TaskListener, String) for additional expansion.