jodd.lagarto.dom

Class Document

java.lang.Object

jodd.lagarto.dom.Node

jodd.lagarto.dom.Document

All Implemented Interfaces:

java.lang.Cloneable

public class Document
extends Node

Document node is always a root node. Holds various DOM-related flags and information.

Nested Class Summary

Nested classes/interfaces inherited from class jodd.lagarto.dom.Node

Node.NodeType

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	collectErrors
protected long	elapsedTime
protected java.util.List<java.lang.String>	errors
protected boolean	lowercase
protected LagartoParserContext	parserContext
protected LagartoNodeHtmlRenderer	renderer

Fields inherited from class jodd.lagarto.dom.Node

attributes, childElementNodes, childElementNodesCount, childNodes, deepLevel, nodeName, nodeRawName, nodeType, nodeValue, offset, ownerDocument, parentNode, position, siblingElementIndex, siblingIndex, siblingNameIndex

Constructor Summary

Constructors

Constructor and Description
Document()
Document(boolean lowercase, boolean collectErrors, LagartoNodeHtmlRenderer renderer, LagartoParserContext parserContext) Document constructor with all relevant flags.

Method Summary

Methods

Modifier and Type	Method and Description
void	addError(java.lang.String message) Add new error message to the errors list.
Document	clone()
protected void	end() Notifies document that parsing is done.
int	getCurrentOffset() Returns current offset during the parsing.
long	getElapsedTime() Returns DOM building elapsed time.
java.util.List<java.lang.String>	getErrors() Returns list of warnings and errors occurred during parsing.
LagartoNodeHtmlRenderer	getRenderer() Returns renderer for nodes.
boolean	isCollectErrors() Returns true if errors are collected.
boolean	isLowercase() Returns true if node names should be converted to lowercase.
void	toHtml(java.lang.Appendable appendable) Generates HTML by appending it to the provided Appendable.

Methods inherited from class jodd.lagarto.dom.Node

addChild, addChild, appendTextContent, changeOwnerDocument, check, cloneTo, detachFromParent, getAttribute, getAttribute, getAttributeInstance, getAttributesCount, getChild, getChild, getChildElement, getChildElements, getChildElementsCount, getChildElementsCount, getChildNodes, getChildNodesCount, getCssPath, getDeepLevel, getFirstChild, getFirstChildElement, getFirstChildElement, getHtml, getInnerHtml, getLastChild, getLastChildElement, getLastChildElement, getNextSibling, getNextSiblingElement, getNextSiblingName, getNodeName, getNodeRawName, getNodeType, getNodeValue, getOffset, getOwnerDocument, getParentNode, getPosition, getPositionString, getPreviousSibling, getPreviousSiblingElement, getPreviousSiblingName, getSiblingElementIndex, getSiblingIndex, getSiblingNameIndex, getTextContent, hasAttribute, hasAttributes, hasChildNodes, indexOfAttributeInstance, initAttributes, initChildElementNodes, initChildNodes, initSiblingNames, insertAfter, insertAfter, insertBefore, insertChild, insertChild, isAttributeIncluding, reindexChildren, reindexChildrenOnAdd, removeAllChilds, removeAttribute, removeChild, removeChild, setAttribute, setAttribute, setNodeValue, toInnerHtml

Methods inherited from class java.lang.Object

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

Field Detail

elapsedTime

protected long elapsedTime

lowercase

protected final boolean lowercase

collectErrors

protected final boolean collectErrors

renderer

protected final LagartoNodeHtmlRenderer renderer

errors

protected java.util.List<java.lang.String> errors

parserContext

protected LagartoParserContext parserContext

Constructor Detail

Document

public Document()

Document

public Document(boolean lowercase,
        boolean collectErrors,
        LagartoNodeHtmlRenderer renderer,
        LagartoParserContext parserContext)

Document constructor with all relevant flags.

Parameters:

lowercase - should all names be converted to lowercase

collectErrors - should we collect errors during the parsing

renderer - renderer instance

parserContext - parser context

Method Detail

clone

public Document clone()

Specified by:

clone in class Node

end

protected void end()

Notifies document that parsing is done.

toHtml

public void toHtml(java.lang.Appendable appendable)
            throws java.io.IOException

Description copied from class: Node

Generates HTML by appending it to the provided Appendable.

Overrides:

toHtml in class Node

Throws:

java.io.IOException

addError

public void addError(java.lang.String message)

Add new error message to the errors list. If errors are not collected error, message is ignored.

getErrors

public java.util.List<java.lang.String> getErrors()

Returns list of warnings and errors occurred during parsing. Returns null if parsing was successful; or if errors are not collected.

getElapsedTime

public long getElapsedTime()

Returns DOM building elapsed time.

isLowercase

public boolean isLowercase()

Returns true if node names should be converted to lowercase. Otherwise, name remains unchanged (ie equals to raw name).

isCollectErrors

public boolean isCollectErrors()

Returns true if errors are collected.

getRenderer

public LagartoNodeHtmlRenderer getRenderer()

Returns renderer for nodes.

getCurrentOffset

public int getCurrentOffset()

Returns current offset during the parsing.