Interface CommentProcessorFactory.IReplaceWithProcessor

Enclosing class:

CommentProcessorFactory

public static interface CommentProcessorFactory.IReplaceWithProcessor

Interface for processors that replace a single word with an expression defined in a comment.

Since:

1.0.8

Version:

${version}

Author:

Joseph Verron, Tom Hombergs

Method Summary

Modifier and Type	Method	Description
void	replaceWith(String expression)	Replaces content with the specified expression.Works only in a single paragraph.
void	replaceWordWith(String expression)	Deprecated, for removal: This API element is subject to removal in a future version. since change in behaviour, it is replace by replaceWith, that does not li;it itself to only one run in the Paragraph

Method Details

replaceWordWith

@Deprecated(since="2.9",
            forRemoval=true)
void replaceWordWith(@Nullable
 String expression)

Deprecated, for removal: This API element is subject to removal in a future version.

since change in behaviour, it is replace by replaceWith, that does not li;it itself to only one run in the Paragraph

Replace a single word inside a paragraph with an expression defined in the comment. The comment should apply to a single word for the replacement to take effect.

Parameters:

expression - the expression to replace the text with

replaceWith

void replaceWith(@Nullable
 String expression)

Replaces content with the specified expression.Works only in a single paragraph.

Parameters:

expression - the expression to replace the content with; it may be null.