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

Class BetweenTokensEditor

java.lang.Object

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

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

All Implemented Interfaces:

ExtensionPoint, Describable<MarkupEditor>

public class BetweenTokensEditor
extends MarkupEditor

Represents a token-based Wiki markup editor that inserts the new content between two (start/end) replacement marker tokens.

Author:

Joe Hansche jhansche@myyearbook.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BetweenTokensEditor.DescriptorImpl

Nested classes/interfaces inherited from class com.myyearbook.hudson.plugins.confluence.wiki.editors.MarkupEditor

MarkupEditor.MarkupEditorDescriptor, MarkupEditor.TokenNotFoundException

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
String	endMarkerToken
String	startMarkerToken

Fields inherited from class com.myyearbook.hudson.plugins.confluence.wiki.editors.MarkupEditor

generator

Constructor Summary

Constructors

Constructor and Description
BetweenTokensEditor(MarkupGenerator generator, String startMarkerToken, String endMarkerToken)

Method Summary

Modifier and Type	Method and Description
String	performEdits(TaskListener listener, String content, String generated, boolean isNewFormat) Inserts the generated content in the section between the startMarkerToken and endMarkerToken.

Methods inherited from class com.myyearbook.hudson.plugins.confluence.wiki.editors.MarkupEditor

all, getDescriptor, log, performReplacement, unquoteToken

Methods inherited from class java.lang.Object

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

Field Detail

startMarkerToken

public final String startMarkerToken

endMarkerToken

public final String endMarkerToken

Constructor Detail

BetweenTokensEditor

@DataBoundConstructor
public BetweenTokensEditor(MarkupGenerator generator,
                                                 String startMarkerToken,
                                                 String endMarkerToken)

Method Detail

performEdits

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

Inserts the generated content in the section between the startMarkerToken and endMarkerToken.

Specified by:

performEdits in class MarkupEditor

Parameters:

listener -

content -

generated -

Returns:

Throws:

TokenNotFoundException

MarkupEditor.TokenNotFoundException