org.jenkinsci.plugins.tokenmacro.impl

Class BuildLogRegexMacro

java.lang.Object

org.jenkinsci.plugins.tokenmacro.TokenMacro

org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro

org.jenkinsci.plugins.tokenmacro.impl.BuildLogRegexMacro

All Implemented Interfaces:

hudson.ExtensionPoint

@Extension
public class BuildLogRegexMacro
extends DataBoundTokenMacro

An EmailContent for build log lines matching a regular expression. Shows lines matching a regular expression (with optional context lines) from the build log file.

Author:

krwalker@stellarscience.com

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
boolean	addNewline
String	defaultValue
boolean	escapeHtml
int	linesAfter
int	linesBefore
static String	MACRO_NAME
String	matchedLineHtmlStyle
int	maxMatches
String	regex
boolean	showTruncatedLines
String	substText

Constructor Summary

Constructors

Constructor and Description
BuildLogRegexMacro()

Method Summary

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<?,?> build, 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

MACRO_NAME

public static final String MACRO_NAME

See Also:

Constant Field Values

regex

public String regex

linesBefore

public int linesBefore

linesAfter

public int linesAfter

maxMatches

public int maxMatches

showTruncatedLines

public boolean showTruncatedLines

substText

public String substText

escapeHtml

public boolean escapeHtml

matchedLineHtmlStyle

public String matchedLineHtmlStyle

addNewline

public boolean addNewline

defaultValue

public String defaultValue

Constructor Detail

BuildLogRegexMacro

public BuildLogRegexMacro()

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<?,?> build,
                       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