Package htmlflow.flowifier

Class AbstractHtmlToJavaHtmlFlowNodeVisitor<T extends Appendable>

java.lang.Object

htmlflow.flowifier.AbstractHtmlToJavaHtmlFlowNodeVisitor<T>

Type Parameters:

T - the type of appendable used to store the Java source code

All Implemented Interfaces:

HtmlToJavaHtmlFlowNodeVisitor<T>, org.jsoup.select.NodeVisitor

Direct Known Subclasses:

DefaultHtmlToJavaHtmlFlowNodeVisitor

public abstract class AbstractHtmlToJavaHtmlFlowNodeVisitor<T extends Appendable>
extends Object
implements HtmlToJavaHtmlFlowNodeVisitor<T>

Defines most of the implementation for a typical visitor of a JSoup node that converts the HTML source code into a Java class except the storage managed by the appendable

Author:

Julien Gouesse

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractHtmlToJavaHtmlFlowNodeVisitor(Supplier<T> appendableSupplier, boolean indented)	Constructor

Method Summary

Modifier and Type	Method	Description
void	appendAttribute(org.jsoup.nodes.Attribute attribute, Class<?> nodeClass)	Appends the attribute value and key
void	appendFooter()	Appends the footer of the Java class, i.e closes the method and the class
void	appendHeader()	Appends the header of the Java class, i.e the imports, the declaration of the class, the declaration of the method, ...
String	convertJavaStringContentToJavaDeclarableString(String unescaped)	Converts the content of a Java string into a string that can be declared in a Java class passed as a method parameter
T	getAppendable()	Returns the appendable used to store the Java class
Class<?>	getClassFromNodeName(String nodeName)	Returns the class of the node whose name is passed if any, otherwise null
Method	getMethodFromAttribute(Class<?> nodeClass, org.jsoup.nodes.Attribute attribute)	Returns the method of the class node that matches with the attribute if any, otherwise null
void	head(org.jsoup.nodes.Node node, int depth)
boolean	isUncloseable(org.jsoup.nodes.Node node)	Tells whether a JSoup node cannot be closed
void	tail(org.jsoup.nodes.Node node, int depth)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHtmlToJavaHtmlFlowNodeVisitor

protected AbstractHtmlToJavaHtmlFlowNodeVisitor(Supplier<T> appendableSupplier,
                                                boolean indented)

Constructor

Parameters:

appendableSupplier - the supplier of the appendable, can create or get an appendable

indented - true if the generated HTML source code is indented, otherwise false

Method Detail

getAppendable

public final T getAppendable()

Description copied from interface: HtmlToJavaHtmlFlowNodeVisitor

Returns the appendable used to store the Java class

Specified by:

getAppendable in interface HtmlToJavaHtmlFlowNodeVisitor<T extends Appendable>

Returns:

the appendable used to store the Java class

appendHeader

public void appendHeader()
                  throws IOException

Description copied from interface: HtmlToJavaHtmlFlowNodeVisitor

Appends the header of the Java class, i.e the imports, the declaration of the class, the declaration of the method, ...

Specified by:

appendHeader in interface HtmlToJavaHtmlFlowNodeVisitor<T extends Appendable>

Throws:

IOException - thrown when something wrong occurs while appending the Java source code

appendFooter

public void appendFooter()
                  throws IOException

Description copied from interface: HtmlToJavaHtmlFlowNodeVisitor

Appends the footer of the Java class, i.e closes the method and the class

Specified by:

appendFooter in interface HtmlToJavaHtmlFlowNodeVisitor<T extends Appendable>

Throws:

IOException - thrown when something wrong occurs while appending the Java source code

convertJavaStringContentToJavaDeclarableString

public String convertJavaStringContentToJavaDeclarableString(String unescaped)

Description copied from interface: HtmlToJavaHtmlFlowNodeVisitor

Converts the content of a Java string into a string that can be declared in a Java class passed as a method parameter

Specified by:

convertJavaStringContentToJavaDeclarableString in interface HtmlToJavaHtmlFlowNodeVisitor<T extends Appendable>

Parameters:

unescaped - the content of a Java string

Returns:

a string that can be declared in a Java class passed as a method parameter

isUncloseable

public boolean isUncloseable(org.jsoup.nodes.Node node)

Description copied from interface: HtmlToJavaHtmlFlowNodeVisitor

Tells whether a JSoup node cannot be closed

Specified by:

isUncloseable in interface HtmlToJavaHtmlFlowNodeVisitor<T extends Appendable>

Parameters:

node - the JSoup node

Returns:

true if the JSoup node cannot be closed, otherwise false

getClassFromNodeName

public Class<?> getClassFromNodeName(String nodeName)

Description copied from interface: HtmlToJavaHtmlFlowNodeVisitor

Returns the class of the node whose name is passed if any, otherwise null

Specified by:

getClassFromNodeName in interface HtmlToJavaHtmlFlowNodeVisitor<T extends Appendable>

Parameters:

nodeName - the node name

Returns:

the class of the node whose name is passed if any, otherwise null

getMethodFromAttribute

public Method getMethodFromAttribute(Class<?> nodeClass,
                                     org.jsoup.nodes.Attribute attribute)

Description copied from interface: HtmlToJavaHtmlFlowNodeVisitor

Returns the method of the class node that matches with the attribute if any, otherwise null

Specified by:

getMethodFromAttribute in interface HtmlToJavaHtmlFlowNodeVisitor<T extends Appendable>

Parameters:

nodeClass - the class of the node

attribute - the attribute

Returns:

the method of the class node that matches with the attribute if any, otherwise null

head

public void head(org.jsoup.nodes.Node node,
                 int depth)

Specified by:

head in interface org.jsoup.select.NodeVisitor

appendAttribute

public void appendAttribute(org.jsoup.nodes.Attribute attribute,
                            Class<?> nodeClass)
                     throws IOException

Description copied from interface: HtmlToJavaHtmlFlowNodeVisitor

Appends the attribute value and key

Specified by:

appendAttribute in interface HtmlToJavaHtmlFlowNodeVisitor<T extends Appendable>

Parameters:

attribute - the attribute

nodeClass - the class of the node

Throws:

IOException - thrown when something wrong occurs while appending the Java source code

tail

public void tail(org.jsoup.nodes.Node node,
                 int depth)

Specified by:

tail in interface org.jsoup.select.NodeVisitor