Package 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:

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

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
String	charSet
String	fileNotFoundMessage
static String	MACRO_NAME
int	maxLines
String	path

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

escapeHtml

Constructor Summary

Constructors

Constructor	Description
WorkspaceFileMacro()

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)
String	evaluate(Run<?,?> run, FilePath workspace, TaskListener listener, String macroName)
List<String>	getAcceptedMacroNames()
boolean	hasNestedContent()	Returns true if this object allows for nested content replacements.

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

evaluate, evaluate, handlesHtmlEscapeInternally

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

path

public String path

fileNotFoundMessage

public String fileNotFoundMessage

maxLines

public int maxLines

charSet

public String charSet

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.

getAcceptedMacroNames

public List<String> getAcceptedMacroNames()

Overrides:

getAcceptedMacroNames in class TokenMacro

evaluate

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

Specified by:

evaluate in class DataBoundTokenMacro

Throws:

MacroEvaluationException

IOException

InterruptedException

evaluate

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

Overrides:

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.