org.jenkinsci.plugins.tokenmacro.impl

Class LogRegExMacro

java.lang.Object

org.jenkinsci.plugins.tokenmacro.TokenMacro

org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro

org.jenkinsci.plugins.tokenmacro.impl.LogRegExMacro

All Implemented Interfaces:

hudson.ExtensionPoint

@Extension
public final class LogRegExMacro
extends DataBoundTokenMacro

Uses a regular expression to find a single log entry and generates a new output using the capture groups from it. This is partially based on the description-setter plugin (https://github.com/jenkinsci/description-setter-plugin).

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	charset Charset to be used in order to read logs from the file.
String	regex
String	replacement

Constructor Summary

Constructors

Constructor and Description
LogRegExMacro()

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<?,?> context, hudson.model.TaskListener listener, String macroName)
String	evaluate(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.model.TaskListener listener, String macroName)
List<String>	getAcceptedMacroNames()
String	readLogFile(File file)

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

regex

public String regex

replacement

public String replacement

charset

public String charset

Charset to be used in order to read logs from the file.

Since:

TODO

Constructor Detail

LogRegExMacro

public LogRegExMacro()

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

readLogFile

public String readLogFile(File file)
                   throws IOException

Throws:

IOException