com.myyearbook.hudson.plugins.confluence.wiki.editors

Class MarkupEditor

java.lang.Object

com.myyearbook.hudson.plugins.confluence.wiki.editors.MarkupEditor

All Implemented Interfaces:

ExtensionPoint, Describable<MarkupEditor>

Direct Known Subclasses:

AfterTokenEditor, AppendEditor, BeforeTokenEditor, BetweenTokensEditor, EntirePageEditor, PrependEditor

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

Base markup editor class

Author:

Joe Hansche jhansche@myyearbook.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MarkupEditor.MarkupEditorDescriptor Descriptor for markup generators
static class	MarkupEditor.TokenNotFoundException Exception thrown when the configured token cannot be found in the wiki markup.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
MarkupGenerator	generator Markup generator

Constructor Summary

Constructors

Constructor and Description
MarkupEditor(MarkupGenerator generator) Creates a generic markup editor

Method Summary

Modifier and Type	Method and Description
static DescriptorExtensionList<MarkupEditor,Descriptor<MarkupEditor>>	all() Returns list descriptors for all MarkupEditor implementations.
Descriptor<MarkupEditor>	getDescriptor() Returns the descriptor for this class
protected void	log(TaskListener listener, String message) Log helper
protected abstract String	performEdits(TaskListener listener, String content, String generated, boolean isNewFormat) Modify the page markup with the given generated content.
String	performReplacement(Run<?,?> build, FilePath filePath, TaskListener listener, String content, boolean isNewFormat, List<com.atlassian.confluence.api.model.content.Content> remoteAttachments) Perform modifications to the page content.
protected String	unquoteToken(String token) Stapler seems to wrap {..} values in double quotes, which breaks marker token searching.

Methods inherited from class java.lang.Object

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

Field Detail

generator

public MarkupGenerator generator

Markup generator

Constructor Detail

MarkupEditor

public MarkupEditor(MarkupGenerator generator)

Creates a generic markup editor

Parameters:

generator - Markup generator

Method Detail

performReplacement

public final String performReplacement(Run<?,?> build,
                                       FilePath filePath,
                                       TaskListener listener,
                                       String content,
                                       boolean isNewFormat,
                                       List<com.atlassian.confluence.api.model.content.Content> remoteAttachments)
                                throws MarkupEditor.TokenNotFoundException

Perform modifications to the page content. Default implementation makes no modifications.

Parameters:

build -

listener -

content -

isNewFormat -

remoteAttachments -

Returns:

Throws:

MarkupEditor.TokenNotFoundException

log

protected void log(TaskListener listener,
                   String message)

Log helper

Parameters:

listener -

message -

unquoteToken

protected final String unquoteToken(String token)

Stapler seems to wrap {..} values in double quotes, which breaks marker token searching. This will strip the double quotes from those strings.

Parameters:

token -

Returns:

token with wrapping double quotes stripped

performEdits

protected abstract String performEdits(TaskListener listener,
                                       String content,
                                       String generated,
                                       boolean isNewFormat)
                                throws MarkupEditor.TokenNotFoundException

Modify the page markup with the given generated content.

Parameters:

listener -

content -

generated -

isNewFormat -

Returns:

Throws:

MarkupEditor.TokenNotFoundException

getDescriptor

public Descriptor<MarkupEditor> getDescriptor()

Returns the descriptor for this class

Specified by:

getDescriptor in interface Describable<MarkupEditor>

Returns:

Descriptor

all

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

Returns list descriptors for all MarkupEditor implementations.

Returns:

List of descriptors