org.devacfr.maven.skins.reflow.snippet

Class Processor

java.lang.Object

org.devacfr.maven.skins.reflow.snippet.Processor

Direct Known Subclasses:

Processor.ShortcodeProcessor, Processor.WebComponentProcessor

public abstract class Processor
extends Object

Specific process for each type of snippet component.

Version:

2.4

Author:

Christophe Friederich

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Processor.ShortcodeProcessor Specific process for snippet shortcode component.
static class	Processor.WebComponentProcessor Specific process for snippet web component.

Field Summary

Fields

Modifier and Type	Field and Description
protected SnippetParser	parser

Constructor Summary

Constructors

Constructor and Description
Processor(SnippetParser parser) Default constructor

Method Summary

Modifier and Type	Method and Description
protected abstract void	appendChildrenToHtml(org.jsoup.nodes.Node node, Appendable writer) Append child Node in html rendering.
protected String	convertElementToHtml(org.jsoup.nodes.Element element) Converts the snippet element to html format.
protected org.jsoup.nodes.Element	convertToHtml(ComponentToken startToken, ComponentToken endToken) Convert the snippet to html.
protected SnippetComponent<?>	createSnippetComponent(ComponentToken startToken, ComponentToken endToken) Create a SnippetComponent.
void	parse(ComponentToken token) Specific parsing for each ComponentToken.

Methods inherited from class java.lang.Object

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

Field Detail

parser

protected final SnippetParser parser

Constructor Detail

Processor

public Processor(SnippetParser parser)

Default constructor

Parameters:

parser - current parser.

Method Detail

parse

public void parse(ComponentToken token)

Specific parsing for each ComponentToken.

Parameters:

token - the current token.

appendChildrenToHtml

protected abstract void appendChildrenToHtml(org.jsoup.nodes.Node node,
                                             Appendable writer)
                                      throws IOException

Append child Node in html rendering.

Parameters:

node - the node to use.

writer - the html writer

Throws:

IOException - If an I/O error occurs.

convertToHtml

protected org.jsoup.nodes.Element convertToHtml(@Nonnull
                                                ComponentToken startToken,
                                                @Nullable
                                                ComponentToken endToken)

Convert the snippet to html.

Parameters:

startToken - the start token

endToken - the end token.

Returns:

Returns a new Element representing html represention of snippet.

createSnippetComponent

protected SnippetComponent<?> createSnippetComponent(ComponentToken startToken,
                                                     ComponentToken endToken)

Create a SnippetComponent.

Parameters:

startToken - the start token.

endToken - the end token.

Returns:

Returns a new instance of SnippetComponent representing the information contained between startToken and endToken.

convertElementToHtml

protected String convertElementToHtml(org.jsoup.nodes.Element element)

Converts the snippet element to html format.

Parameters:

element - the html element to use.

Returns:

Returns a String representing the snippet element in html format.