Package org.jsoup.nodes

Class XmlDeclaration

java.lang.Object

org.jsoup.nodes.Node

org.jsoup.nodes.LeafNode

org.jsoup.nodes.XmlDeclaration

All Implemented Interfaces:

java.lang.Cloneable

public class XmlDeclaration
extends LeafNode

An XML Declaration.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	isProcessingInstruction

Fields inherited from class org.jsoup.nodes.LeafNode

value

Fields inherited from class org.jsoup.nodes.Node

EmptyString, parentNode, siblingIndex

Constructor Summary

Constructors

Constructor	Description
XmlDeclaration(java.lang.String name, boolean isProcessingInstruction)	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.
java.lang.String	getWholeDeclaration()	Get the unencoded XML declaration.
private void	getWholeDeclaration(java.lang.Appendable accum, Document.OutputSettings out)
java.lang.String	name()	Get the name of this declaration.
java.lang.String	nodeName()	Get the node name of this node.
(package private) void	outerHtmlHead(java.lang.Appendable accum, int depth, Document.OutputSettings out)	Get the outer HTML of this node.
(package private) void	outerHtmlTail(java.lang.Appendable accum, int depth, Document.OutputSettings out)
java.lang.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, removeAttr

Methods inherited from class org.jsoup.nodes.Node

addChildren, addChildren, after, after, before, before, childNode, childNodes, childNodesAsArray, childNodesCopy, clearAttributes, equals, filter, hasParent, hasSameValue, html, indent, nextSibling, nodelistChanged, outerHtml, outerHtml, ownerDocument, parent, parentNode, previousSibling, remove, removeChild, reparentChild, replaceChild, replaceWith, root, setBaseUri, setParentNode, setSiblingIndex, shallowClone, siblingIndex, siblingNodes, traverse, unwrap, wrap

Methods inherited from class java.lang.Object

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

Field Detail

isProcessingInstruction

private final boolean isProcessingInstruction

Constructor Detail

XmlDeclaration

public XmlDeclaration(java.lang.String name,
                      boolean isProcessingInstruction)

Create a new XML declaration

Parameters:

name - of declaration

isProcessingInstruction - is processing instruction

Method Detail

nodeName

public java.lang.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 java.lang.String name()

Get the name of this declaration.

Returns:

name of this declaration.

getWholeDeclaration

public java.lang.String getWholeDeclaration()

Get the unencoded XML declaration.

Returns:

XML declaration

getWholeDeclaration

private void getWholeDeclaration(java.lang.Appendable accum,
                                 Document.OutputSettings out)
                          throws java.io.IOException

Throws:

java.io.IOException

outerHtmlHead

void outerHtmlHead(java.lang.Appendable accum,
                   int depth,
                   Document.OutputSettings out)
            throws java.io.IOException

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

Throws:

java.io.IOException - if appending to the given accumulator fails.

outerHtmlTail

void outerHtmlTail(java.lang.Appendable accum,
                   int depth,
                   Document.OutputSettings out)

Specified by:

outerHtmlTail in class Node

toString

public java.lang.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 or parent node. As a stand-alone object, any changes made to the clone or any of its children will not impact the original node.

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()