Package org.jenkinsci.plugins.tokenmacro.impl

Class BuildLogExcerptMacro

java.lang.Object

org.jenkinsci.plugins.tokenmacro.TokenMacro

org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro

org.jenkinsci.plugins.tokenmacro.impl.BuildLogExcerptMacro

All Implemented Interfaces:

ExtensionPoint

@Extension
public class BuildLogExcerptMacro
extends DataBoundTokenMacro

Author:

Nicolas De loof

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	end
static final String	MACRO_NAME
String	start

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

escapeHtml

Constructor Summary

Constructors

Constructor	Description
BuildLogExcerptMacro()

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()

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

MACRO_NAME

public static final String MACRO_NAME

See Also:

• Constant Field Values

start

public String start

end

public String end

Constructor Details

BuildLogExcerptMacro

public BuildLogExcerptMacro()

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.

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