com.myyearbook.hudson.plugins.confluence.wiki.generators

Class MarkupGenerator

java.lang.Object

com.myyearbook.hudson.plugins.confluence.wiki.generators.MarkupGenerator

All Implemented Interfaces:

ExtensionPoint, Describable<MarkupGenerator>

Direct Known Subclasses:

FileGenerator, PlainTextGenerator

public abstract class MarkupGenerator
extends Object
implements Describable<MarkupGenerator>, ExtensionPoint

Abstract class representing a method of generating Confluence wiki markup.

Author:

Joe Hansche jhansche@myyearbook.com

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
MarkupGenerator()

Method Summary

Modifier and Type	Method and Description
static DescriptorExtensionList<MarkupGenerator,Descriptor<MarkupGenerator>>	all() Returns all MarkupGenerator descriptors
protected String	expand(Run<?,?> build, TaskListener listener, String generated, List<com.atlassian.confluence.api.model.content.Content> remoteAttachments) Expands replacement variables in the generated text
protected String	expandAttachmentsLink(TaskListener listener, String generated, List<com.atlassian.confluence.api.model.content.Content> remoteAttachments) Expands replacement $LINK[n] variables with uploaded files links
abstract String	generateMarkup(Run<?,?> build, FilePath filePath, TaskListener listener, List<com.atlassian.confluence.api.model.content.Content> remoteAttachments) Generates markup to be used for replacement
Descriptor<MarkupGenerator>	getDescriptor()

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkupGenerator

public MarkupGenerator()

Method Detail

getDescriptor

public Descriptor<MarkupGenerator> getDescriptor()

Specified by:

getDescriptor in interface Describable<MarkupGenerator>

all

public static DescriptorExtensionList<MarkupGenerator,Descriptor<MarkupGenerator>> all()

Returns all MarkupGenerator descriptors

Returns:

generateMarkup

public abstract String generateMarkup(Run<?,?> build,
                                      FilePath filePath,
                                      TaskListener listener,
                                      List<com.atlassian.confluence.api.model.content.Content> remoteAttachments)

Generates markup to be used for replacement

Parameters:

build -

listener -

Returns:

expand

protected String expand(Run<?,?> build,
                        TaskListener listener,
                        String generated,
                        List<com.atlassian.confluence.api.model.content.Content> remoteAttachments)

Expands replacement variables in the generated text

Parameters:

build -

listener -

generated -

Returns:

expandAttachmentsLink

protected String expandAttachmentsLink(TaskListener listener,
                                       String generated,
                                       List<com.atlassian.confluence.api.model.content.Content> remoteAttachments)

Expands replacement $LINK[n] variables with uploaded files links

Parameters:

listener -

generated -

remoteAttachments -

Returns: