Package org.jsoup.parser

Class XmlTreeBuilder

java.lang.Object

org.jsoup.parser.TreeBuilder

org.jsoup.parser.XmlTreeBuilder

public class XmlTreeBuilder
extends TreeBuilder

Use the XmlTreeBuilder when you want to parse XML without any of the HTML DOM rules being applied to the document.

Usage example: Document xmlDoc = Jsoup.parse(html, baseUrl, Parser.xmlParser());

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	XmlTreeBuilder.NamespaceChange	Tracks namespace binding changes within element scopes.

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	maxQueueDepth
(package private) final HashMap<String,String>	namespaceBindings
(package private) final ArrayDeque<XmlTreeBuilder.NamespaceChange>	namespaceChanges
private static final XmlTreeBuilder.NamespaceChange	ScopeMarker
(package private) static final String	XmlnsKey
(package private) static final String	XmlnsPrefix

Fields inherited from class org.jsoup.parser.TreeBuilder

baseUri, currentToken, doc, nodeListener, parser, reader, settings, stack, tagSet, tokeniser, trackSourceRange

Constructor Summary

Constructors

Constructor	Description
XmlTreeBuilder()

Method Summary

Modifier and Type	Method	Description
private void	applyNamespaceDeclarations(Attributes attributes)	Applies namespace declarations and records changes within an element scope.
private void	applyNamespacesToAttributes(Attributes attributes)	Applies resolved namespace URIs to prefixed attributes.
(package private) List<Node>	completeParseFragment()
(package private) int	defaultMaxDepth()	Default maximum depth for parsers using this tree builder.
String	defaultNamespace()	Gets the default namespace for this TreeBuilder
(package private) ParseSettings	defaultSettings()
(package private) TagSet	defaultTagSet()
protected void	initialiseParse(Reader input, String baseUri, Parser parser)
(package private) void	initialiseParseFragment(Element context)
(package private) void	insertCharacterFor(Token.Character token)
(package private) void	insertCommentFor(Token.Comment commentToken)
(package private) void	insertDoctypeFor(Token.Doctype token)
(package private) void	insertElementFor(Token.StartTag startTag)
(package private) void	insertLeafNode(LeafNode node)
(package private) void	insertXmlDeclarationFor(Token.XmlDecl token)
(package private) XmlTreeBuilder	newInstance()	Create a new copy of this TreeBuilder
(package private) Document	parse(Reader input, String baseUri)
(package private) Document	parse(String input, String baseUri)
(package private) Element	pop()	Removes the last Element from the stack, hits onNodeClosed, and then returns it.
protected void	popStackToClose(Token.EndTag endTag)	If the stack contains an element with this tag's name, pop up the stack to remove the first occurrence.
protected boolean	process(Token token)
private String	resolveNamespace(String tagName)	Resolves the namespace URI for a qualified tag name.

Methods inherited from class org.jsoup.parser.TreeBuilder

completeParse, currentElement, currentElementIs, currentElementIs, enforceStackDepthLimit, error, error, nodeListener, onNodeClosed, onNodeInserted, onStackPrunedForDepth, parse, parseFragment, processEndTag, processStartTag, processStartTag, push, runParser, stepParser, tagFor, tagFor, trackNodePosition

Methods inherited from class java.lang.Object

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

Field Details

XmlnsKey

static final String XmlnsKey

See Also:

• Constant Field Values

XmlnsPrefix

static final String XmlnsPrefix

See Also:

• Constant Field Values

ScopeMarker

private static final XmlTreeBuilder.NamespaceChange ScopeMarker

namespaceBindings

final HashMap<String,String> namespaceBindings

namespaceChanges

final ArrayDeque<XmlTreeBuilder.NamespaceChange> namespaceChanges

maxQueueDepth

private static final int maxQueueDepth

See Also:

• Constant Field Values

Constructor Details

XmlTreeBuilder

public XmlTreeBuilder()

Method Details

defaultSettings

ParseSettings defaultSettings()

Specified by:

defaultSettings in class TreeBuilder

initialiseParse

protected void initialiseParse(Reader input,
 String baseUri,
 Parser parser)

Overrides:

initialiseParse in class TreeBuilder

initialiseParseFragment

void initialiseParseFragment(Element context)

Overrides:

initialiseParseFragment in class TreeBuilder

parse

Document parse(Reader input,
 String baseUri)

parse

Document parse(String input,
 String baseUri)

completeParseFragment

List<Node> completeParseFragment()

Specified by:

completeParseFragment in class TreeBuilder

newInstance

XmlTreeBuilder newInstance()

Description copied from class: TreeBuilder

Create a new copy of this TreeBuilder

Specified by:

newInstance in class TreeBuilder

Returns:

copy, ready for a new parse

defaultNamespace

public String defaultNamespace()

Description copied from class: TreeBuilder

Gets the default namespace for this TreeBuilder

Overrides:

defaultNamespace in class TreeBuilder

Returns:

the default namespace

defaultTagSet

TagSet defaultTagSet()

Overrides:

defaultTagSet in class TreeBuilder

defaultMaxDepth

int defaultMaxDepth()

Description copied from class: TreeBuilder

Default maximum depth for parsers using this tree builder.

Overrides:

defaultMaxDepth in class TreeBuilder

process

protected boolean process(Token token)

Specified by:

process in class TreeBuilder

insertElementFor

void insertElementFor(Token.StartTag startTag)

applyNamespaceDeclarations

private void applyNamespaceDeclarations(Attributes attributes)

Applies namespace declarations and records changes within an element scope.

applyNamespacesToAttributes

private void applyNamespacesToAttributes(Attributes attributes)

Applies resolved namespace URIs to prefixed attributes.

resolveNamespace

private String resolveNamespace(String tagName)

Resolves the namespace URI for a qualified tag name.

pop

Element pop()

Description copied from class: TreeBuilder

Removes the last Element from the stack, hits onNodeClosed, and then returns it.

Overrides:

pop in class TreeBuilder

Returns:

insertLeafNode

void insertLeafNode(LeafNode node)

insertCommentFor

void insertCommentFor(Token.Comment commentToken)

insertCharacterFor

void insertCharacterFor(Token.Character token)

insertDoctypeFor

void insertDoctypeFor(Token.Doctype token)

insertXmlDeclarationFor

void insertXmlDeclarationFor(Token.XmlDecl token)

popStackToClose

protected void popStackToClose(Token.EndTag endTag)

If the stack contains an element with this tag's name, pop up the stack to remove the first occurrence. If not found, skips.

Parameters:

endTag - tag to close