Package org.jenkinsci.plugins.github.common

Class ExpandableMessage

java.lang.Object

hudson.model.AbstractDescribableImpl<ExpandableMessage>

org.jenkinsci.plugins.github.common.ExpandableMessage

All Implemented Interfaces:

Describable<ExpandableMessage>

public class ExpandableMessage
extends AbstractDescribableImpl<ExpandableMessage>

Represents a message that can contain token macros. uses https://wiki.jenkins-ci.org/display/JENKINS/Token+Macro+Plugin to expand vars

Since:

1.14.1

Author:

Kanstantsin Shautsou, Alina Karpovich

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExpandableMessage.DescriptorImpl

Constructor Summary

Constructors

Constructor	Description
ExpandableMessage(String content)

Method Summary

Modifier and Type	Method	Description
String	expandAll(Run<?,?> run, TaskListener listener)	Expands all env vars.
String	getContent()
ExpandableMessage.DescriptorImpl	getDescriptor()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpandableMessage

@DataBoundConstructor
public ExpandableMessage(String content)

Method Detail

expandAll

public String expandAll(Run<?,?> run,
                        TaskListener listener)
                 throws IOException,
                        InterruptedException

Expands all env vars. In case of AbstractBuild also expands token macro and build vars

Parameters:

run - build context

listener - usually used to log something to console while building env vars

Returns:

string with expanded vars and tokens

Throws:

IOException

InterruptedException

getContent

public String getContent()

getDescriptor

public ExpandableMessage.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<ExpandableMessage>

Overrides:

getDescriptor in class AbstractDescribableImpl<ExpandableMessage>