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, such as <?xml version="1.0"?>, or a markup declaration, such as <!ELEMENT ...>. Use ProcessingInstruction for other <?target data?> nodes. Declaration values are available through LeafNode.attributes() and LeafNode.attr(String).

Constructor Summary

Constructors

Constructor	Description
XmlDeclaration(String name, boolean isMarkupDeclaration)	Creates an XML declaration or markup 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()	Gets the declaration data, without its name or delimiters.
String	name()	Gets the declaration name.
String	nodeName()	Get the node name of this node.
String	toString()	Gets this node's outer HTML.

Methods inherited from class org.jsoup.nodes.LeafNode

absUrl, attr, attr, attributes, baseUri, childNodeSize, 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, 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

Constructor Details

XmlDeclaration

public XmlDeclaration(String name,
 boolean isMarkupDeclaration)

Creates an XML declaration or markup declaration.

Parameters:

name - the declaration name, such as xml or ELEMENT

isMarkupDeclaration - true to create <!name ...>; false to create <?name ...?>

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

Gets the declaration name.

Returns:

the declaration name

getWholeDeclaration

public String getWholeDeclaration()

Gets the declaration data, without its name or delimiters.

Returns:

the declaration data

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