Package org.jsoup.nodes

Class XmlDeclaration

java.lang.Object

org.jsoup.nodes.Node

org.jsoup.nodes.LeafNode

org.jsoup.nodes.XmlDeclaration

All Implemented Interfaces:

Cloneable

public class XmlDeclaration
extends LeafNode

An XML Declaration. Includes support for treating the declaration contents as pseudo attributes.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	isDeclaration	First char is `!` if isDeclaration, like in <!ENTITY ...>.

Fields inherited from class org.jsoup.nodes.LeafNode

value

Fields inherited from class org.jsoup.nodes.Node

EmptyNodes, EmptyString, parentNode, siblingIndex

Constructor Summary

Constructors

Constructor	Description
XmlDeclaration(String name, boolean isDeclaration)	Create a new XML declaration

Method Summary

Modifier and Type	Method	Description
XmlDeclaration	clone()	Create a stand-alone, deep copy of this node, and all of its children.
String	getWholeDeclaration()	Get the unencoded XML declaration.
private void	getWholeDeclaration(QuietAppendable accum, Document.OutputSettings out)
String	name()	Get the name of this declaration.
String	nodeName()	Get the node name of this node.
(package private) void	outerHtmlHead(QuietAppendable accum, Document.OutputSettings out)	Get the outer HTML of this node.
(package private) void	outerHtmlTail(QuietAppendable accum, Document.OutputSettings out)
String	toString()	Gets this node's outer HTML.

Methods inherited from class org.jsoup.nodes.LeafNode

absUrl, attr, attr, attributes, baseUri, childNodeSize, coreValue, coreValue, doClone, doSetBaseUri, empty, ensureChildNodes, hasAttr, hasAttributes, nodeValue, parent, removeAttr

Methods inherited from class org.jsoup.nodes.Node

addChildren, addChildren, after, after, attributesSize, before, before, childNode, childNodes, childNodesAsArray, childNodesCopy, clearAttributes, equals, filter, firstChild, firstSibling, forEachNode, hashCode, hasParent, hasSameValue, html, indent, lastChild, lastSibling, nameIs, nextElementSibling, nextSibling, nodeStream, nodeStream, normalName, outerHtml, outerHtml, outerHtml, ownerDocument, parentElement, parentElementIs, parentNameIs, parentNode, previousElementSibling, previousSibling, remove, removeChild, reparentChild, replaceChild, replaceWith, root, setBaseUri, setParentNode, setSiblingIndex, shallowClone, siblingIndex, siblingNodes, sourceRange, traverse, unwrap, wrap

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

isDeclaration

private final boolean isDeclaration

First char is `!` if isDeclaration, like in <!ENTITY ...>. Otherwise, is `?`, a processing instruction, like <?xml .... ?> (and note trailing `?`).

Constructor Details

XmlDeclaration

public XmlDeclaration(String name,
 boolean isDeclaration)

Create a new XML declaration

Parameters:

name - of declaration

isDeclaration - true if a declaration (first char is `!`), otherwise a processing instruction (first char is `?`).

Method Details

nodeName

public String nodeName()

Description copied from class: Node

Get the node name of this node. Use for debugging purposes and not logic switching (for that, use instanceof).

Specified by:

nodeName in class Node

Returns:

node name

name

public String name()

Get the name of this declaration.

Returns:

name of this declaration.

getWholeDeclaration

public String getWholeDeclaration()

Get the unencoded XML declaration.

Returns:

XML declaration

getWholeDeclaration

private void getWholeDeclaration(QuietAppendable accum,
 Document.OutputSettings out)

outerHtmlHead

void outerHtmlHead(QuietAppendable accum,
 Document.OutputSettings out)

Description copied from class: Node

Get the outer HTML of this node.

Specified by:

outerHtmlHead in class Node

Parameters:

accum - accumulator to place HTML into

out -

outerHtmlTail

void outerHtmlTail(QuietAppendable accum,
 Document.OutputSettings out)

Overrides:

outerHtmlTail in class LeafNode

toString

public String toString()

Description copied from class: Node

Gets this node's outer HTML.

Overrides:

toString in class Node

Returns:

outer HTML.

See Also:

• Node.outerHtml()

clone

public XmlDeclaration clone()

Description copied from class: Node

Create a stand-alone, deep copy of this node, and all of its children. The cloned node will have no siblings.

• If this node is a LeafNode, the clone will have no parent.
• If this node is an Element, the clone will have a simple owning Document to retain the configured output settings and parser.

The cloned node may be adopted into another Document or node structure using Element.appendChild(Node).

Overrides:

clone in class Node

Returns:

a stand-alone cloned node, including clones of any children

See Also:

• Node.shallowClone()