jodd.lagarto.dom

Class LagartoDOMBuilder

java.lang.Object

jodd.lagarto.dom.LagartoDOMBuilder

All Implemented Interfaces:

DOMBuilder

public class LagartoDOMBuilder
extends java.lang.Object
implements DOMBuilder

Lagarto DOM builder creates DOM tree from HTML, XHTML or XML content.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	calculatePosition
protected boolean	caseSensitive
protected boolean	collectErrors
protected java.lang.String	conditionalCommentExpression
protected boolean	enableConditionalComments
static java.lang.String[]	HTML5_VOID_TAGS Default void tags.
protected boolean	ignoreComments
protected boolean	ignoreWhitespacesBetweenTags
protected boolean	impliedEndTags
protected boolean	parseSpecialTagsAsCdata
protected LagartoNodeHtmlRenderer	renderer
protected boolean	selfCloseVoidTags
protected boolean	unclosedTagAsOrphanCheck
protected boolean	useFosterRules
protected java.lang.String[]	voidTags

Constructor Summary

Constructors

Constructor and Description
LagartoDOMBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
LagartoDOMBuilder	disableDebug() Disables debug mode.
protected Document	doParse(LagartoParser lagartoParser) Parses the content using provided lagarto parser.
LagartoDOMBuilder	enableDebug() Enables debug mode.
LagartoDOMBuilder	enableHtmlMode() Enables HTML5 parsing mode.
LagartoDOMBuilder	enableHtmlPlusMode() Enables html mode with additional and somewhat experimental rules.
LagartoDOMBuilder	enableXhtmlMode() Enables XHTML mode.
LagartoDOMBuilder	enableXmlMode() Enables XML parsing mode.
java.lang.String	getConditionalCommentExpression()
LagartoNodeHtmlRenderer	getRenderer() Returns LagartoNodeHtmlRenderer instance that generates HTML output.
java.lang.String[]	getVoidTags()
boolean	hasVoidTags() Returns true if void tags are used.
boolean	isCalculatePosition()
boolean	isCaseSensitive()
boolean	isCollectErrors()
boolean	isEnableConditionalComments()
boolean	isIgnoreComments()
boolean	isIgnoreWhitespacesBetweenTags()
boolean	isImpliedEndTags()
boolean	isParseSpecialTagsAsCdata()
boolean	isSelfCloseVoidTags()
boolean	isUnclosedTagAsOrphanCheck()
boolean	isUseFosterRules() Returns true if foster rules should be used.
boolean	isVoidTag(java.lang.String tagName) Returns true if tag name is void.
Document	parse(java.nio.CharBuffer content) Creates DOM tree from the provided content.
Document	parse(java.lang.CharSequence content) Creates DOM tree from provided content.
LagartoDOMBuilder	setCalculatePosition(boolean calculatePosition)
LagartoDOMBuilder	setCaseSensitive(boolean caseSensitive) Specifies if tag names are case sensitive.
LagartoDOMBuilder	setCollectErrors(boolean collectErrors) Enables error collection during parsing.
LagartoDOMBuilder	setConditionalCommentExpression(java.lang.String conditionalCommentExpression)
LagartoDOMBuilder	setEnableConditionalComments(boolean enableConditionalComments)
LagartoDOMBuilder	setIgnoreComments(boolean ignoreComments) Specifies if comments should be ignored in DOM tree.
LagartoDOMBuilder	setIgnoreWhitespacesBetweenTags(boolean ignoreWhitespacesBetweenTags) Specifies if whitespaces between open/closed tags should be ignored.
LagartoDOMBuilder	setImpliedEndTags(boolean impliedEndTags) Enables implied end tags for certain tags.
LagartoDOMBuilder	setParseSpecialTagsAsCdata(boolean parseSpecialTagsAsCdata)
LagartoDOMBuilder	setRenderer(LagartoNodeHtmlRenderer renderer) Sets new renderer.
LagartoDOMBuilder	setSelfCloseVoidTags(boolean selfCloseVoidTags) Specifies if void tags should be self closed.
LagartoDOMBuilder	setUnclosedTagAsOrphanCheck(boolean unclosedTagAsOrphanCheck)
LagartoDOMBuilder	setUseFosterRules(boolean useFosterRules)
LagartoDOMBuilder	setVoidTags(java.lang.String... voidTags) Sets void tags.

Methods inherited from class java.lang.Object

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

Field Detail

HTML5_VOID_TAGS

public static final java.lang.String[] HTML5_VOID_TAGS

Default void tags. http://dev.w3.org/html5/spec/Overview.html#void-elements

parseSpecialTagsAsCdata

protected boolean parseSpecialTagsAsCdata

enableConditionalComments

protected boolean enableConditionalComments

calculatePosition

protected boolean calculatePosition

ignoreWhitespacesBetweenTags

protected boolean ignoreWhitespacesBetweenTags

caseSensitive

protected boolean caseSensitive

ignoreComments

protected boolean ignoreComments

selfCloseVoidTags

protected boolean selfCloseVoidTags

collectErrors

protected boolean collectErrors

conditionalCommentExpression

protected java.lang.String conditionalCommentExpression

voidTags

protected java.lang.String[] voidTags

impliedEndTags

protected boolean impliedEndTags

renderer

protected LagartoNodeHtmlRenderer renderer

useFosterRules

protected boolean useFosterRules

unclosedTagAsOrphanCheck

protected boolean unclosedTagAsOrphanCheck

Constructor Detail

LagartoDOMBuilder

public LagartoDOMBuilder()

Method Detail

isUnclosedTagAsOrphanCheck

public boolean isUnclosedTagAsOrphanCheck()

setUnclosedTagAsOrphanCheck

public LagartoDOMBuilder setUnclosedTagAsOrphanCheck(boolean unclosedTagAsOrphanCheck)

isUseFosterRules

public boolean isUseFosterRules()

Returns true if foster rules should be used.

setUseFosterRules

public LagartoDOMBuilder setUseFosterRules(boolean useFosterRules)

isParseSpecialTagsAsCdata

public boolean isParseSpecialTagsAsCdata()

setParseSpecialTagsAsCdata

public LagartoDOMBuilder setParseSpecialTagsAsCdata(boolean parseSpecialTagsAsCdata)

isEnableConditionalComments

public boolean isEnableConditionalComments()

setEnableConditionalComments

public LagartoDOMBuilder setEnableConditionalComments(boolean enableConditionalComments)

isCalculatePosition

public boolean isCalculatePosition()

setCalculatePosition

public LagartoDOMBuilder setCalculatePosition(boolean calculatePosition)

getRenderer

public LagartoNodeHtmlRenderer getRenderer()

Returns LagartoNodeHtmlRenderer instance that generates HTML output.

setRenderer

public LagartoDOMBuilder setRenderer(LagartoNodeHtmlRenderer renderer)

Sets new renderer.

isIgnoreWhitespacesBetweenTags

public boolean isIgnoreWhitespacesBetweenTags()

setIgnoreWhitespacesBetweenTags

public LagartoDOMBuilder setIgnoreWhitespacesBetweenTags(boolean ignoreWhitespacesBetweenTags)

Specifies if whitespaces between open/closed tags should be ignored.

isCaseSensitive

public boolean isCaseSensitive()

setCaseSensitive

public LagartoDOMBuilder setCaseSensitive(boolean caseSensitive)

Specifies if tag names are case sensitive.

isIgnoreComments

public boolean isIgnoreComments()

setIgnoreComments

public LagartoDOMBuilder setIgnoreComments(boolean ignoreComments)

Specifies if comments should be ignored in DOM tree.

getVoidTags

public java.lang.String[] getVoidTags()

setVoidTags

public LagartoDOMBuilder setVoidTags(java.lang.String... voidTags)

Sets void tags. If null, void tags are not used.

hasVoidTags

public boolean hasVoidTags()

Returns true if void tags are used. Using void tags makes parsing a different.

isVoidTag

public boolean isVoidTag(java.lang.String tagName)

Returns true if tag name is void. If void tags are not defined, returns false for any input.

isSelfCloseVoidTags

public boolean isSelfCloseVoidTags()

setSelfCloseVoidTags

public LagartoDOMBuilder setSelfCloseVoidTags(boolean selfCloseVoidTags)

Specifies if void tags should be self closed.

isCollectErrors

public boolean isCollectErrors()

setCollectErrors

public LagartoDOMBuilder setCollectErrors(boolean collectErrors)

Enables error collection during parsing.

getConditionalCommentExpression

public java.lang.String getConditionalCommentExpression()

setConditionalCommentExpression

public LagartoDOMBuilder setConditionalCommentExpression(java.lang.String conditionalCommentExpression)

isImpliedEndTags

public boolean isImpliedEndTags()

setImpliedEndTags

public LagartoDOMBuilder setImpliedEndTags(boolean impliedEndTags)

Enables implied end tags for certain tags. This flag reduces the performances a bit, so if you are dealing with 'straight' html that uses closes tags, consider switching this flag off.

enableDebug

public LagartoDOMBuilder enableDebug()

Enables debug mode. Performances are lost.

disableDebug

public LagartoDOMBuilder disableDebug()

Disables debug mode.

enableHtmlPlusMode

public LagartoDOMBuilder enableHtmlPlusMode()

Enables html mode with additional and somewhat experimental rules.

enableHtmlMode

public LagartoDOMBuilder enableHtmlMode()

Enables HTML5 parsing mode.

enableXhtmlMode

public LagartoDOMBuilder enableXhtmlMode()

Enables XHTML mode.

enableXmlMode

public LagartoDOMBuilder enableXmlMode()

Enables XML parsing mode.

parse

public Document parse(java.lang.CharSequence content)

Creates DOM tree from provided content.

Specified by:

parse in interface DOMBuilder

parse

public Document parse(java.nio.CharBuffer content)

Creates DOM tree from the provided content.

Specified by:

parse in interface DOMBuilder

doParse

protected Document doParse(LagartoParser lagartoParser)

Parses the content using provided lagarto parser.