Package org.jsoup.nodes
Class XmlDeclaration
- java.lang.Object
-
- org.jsoup.nodes.Node
-
- org.jsoup.nodes.XmlDeclaration
-
- All Implemented Interfaces:
java.lang.Cloneable
public class XmlDeclaration extends Node
An XML Declaration.
-
-
Constructor Summary
Constructors Constructor Description XmlDeclaration(java.lang.String name, boolean isProcessingInstruction)
Create a new XML declaration
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
absUrl(java.lang.String key)
Get an absolute URL from a URL attribute that may be relative (such as an<a href>
or<img src>
).java.lang.String
attr(java.lang.String key)
Get an attribute's value by its key.Node
attr(java.lang.String key, java.lang.String value)
Set an attribute (key=value).Attributes
attributes()
Get all of the element's attributes.java.lang.String
baseUri()
Get the base URI that applies to this node.int
childNodeSize()
Get the number of child nodes that this node holds.XmlDeclaration
clone()
Create a stand-alone, deep copy of this node, and all of its children.protected org.jsoup.nodes.LeafNode
doClone(Node parent)
protected void
doSetBaseUri(java.lang.String baseUri)
Set the baseUri for just this node (not its descendants), if this Node tracks base URIs.Node
empty()
Delete all this node's children.protected java.util.List<Node>
ensureChildNodes()
java.lang.String
getWholeDeclaration()
Get the unencoded XML declaration.boolean
hasAttr(java.lang.String key)
Test if this Node has an attribute.protected boolean
hasAttributes()
Check if this Node has an actual Attributes object.java.lang.String
name()
Get the name of this declaration.java.lang.String
nodeName()
Get the node name of this node.Node
removeAttr(java.lang.String key)
Remove an attribute from this node.java.lang.String
toString()
Gets this node's outer HTML.-
Methods inherited from class org.jsoup.nodes.Node
addChildren, addChildren, after, after, attributesSize, before, before, childNode, childNodes, childNodesAsArray, childNodesCopy, clearAttributes, equals, filter, hasParent, hasSameValue, html, indent, nextSibling, outerHtml, outerHtml, ownerDocument, parent, parentNode, previousSibling, remove, removeChild, reparentChild, replaceChild, replaceWith, root, setBaseUri, setParentNode, setSiblingIndex, shallowClone, siblingIndex, siblingNodes, traverse, unwrap, wrap
-
-
-
-
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).
-
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
-
toString
public java.lang.String toString()
Description copied from class:Node
Gets this node's outer HTML.- Overrides:
toString
in classNode
- 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 classNode
- Returns:
- a stand-alone cloned node, including clones of any children
- See Also:
Node.shallowClone()
-
hasAttributes
protected final boolean hasAttributes()
Description copied from class:Node
Check if this Node has an actual Attributes object.- Specified by:
hasAttributes
in classNode
-
attributes
public final Attributes attributes()
Description copied from class:Node
Get all of the element's attributes.- Specified by:
attributes
in classNode
- Returns:
- attributes (which implements iterable, in same order as presented in original HTML).
-
attr
public java.lang.String attr(java.lang.String key)
Description copied from class:Node
Get an attribute's value by its key. Case insensitiveTo get an absolute URL from an attribute that may be a relative URL, prefix the key with
E.g.:abs
, which is a shortcut to theNode.absUrl(java.lang.String)
method.String url = a.attr("abs:href");
- Overrides:
attr
in classNode
- Parameters:
key
- The attribute key.- Returns:
- The attribute, or empty string if not present (to avoid nulls).
- See Also:
Node.attributes()
,Node.hasAttr(String)
,Node.absUrl(String)
-
attr
public Node attr(java.lang.String key, java.lang.String value)
Description copied from class:Node
Set an attribute (key=value). If the attribute already exists, it is replaced. The attribute key comparison is case insensitive. The key will be set with case sensitivity as set in the parser settings.
-
hasAttr
public boolean hasAttr(java.lang.String key)
Description copied from class:Node
Test if this Node has an attribute. Case insensitive.
-
removeAttr
public Node removeAttr(java.lang.String key)
Description copied from class:Node
Remove an attribute from this node.- Overrides:
removeAttr
in classNode
- Parameters:
key
- The attribute to remove.- Returns:
- this (for chaining)
-
absUrl
public java.lang.String absUrl(java.lang.String key)
Description copied from class:Node
Get an absolute URL from a URL attribute that may be relative (such as an<a href>
or<img src>
).E.g.:
String absUrl = linkEl.absUrl("href");
If the attribute value is already absolute (i.e. it starts with a protocol, like
http://
orhttps://
etc), and it successfully parses as a URL, the attribute is returned directly. Otherwise, it is treated as a URL relative to the element'sNode.baseUri()
, and made absolute using that.As an alternate, you can use the
Node.attr(java.lang.String)
method with theabs:
prefix, e.g.:String absUrl = linkEl.attr("abs:href");
- Overrides:
absUrl
in classNode
- Parameters:
key
- The attribute key- Returns:
- An absolute URL if one could be made, or an empty string (not null) if the attribute was missing or could not be made successfully into a URL.
- See Also:
Node.attr(java.lang.String)
,URL(java.net.URL, String)
-
baseUri
public java.lang.String baseUri()
Description copied from class:Node
Get the base URI that applies to this node. Will return an empty string if not defined. Used to make relative links absolute.- Specified by:
baseUri
in classNode
- Returns:
- base URI
- See Also:
Node.absUrl(java.lang.String)
-
doSetBaseUri
protected void doSetBaseUri(java.lang.String baseUri)
Description copied from class:Node
Set the baseUri for just this node (not its descendants), if this Node tracks base URIs.- Specified by:
doSetBaseUri
in classNode
- Parameters:
baseUri
- new URI
-
childNodeSize
public int childNodeSize()
Description copied from class:Node
Get the number of child nodes that this node holds.- Specified by:
childNodeSize
in classNode
- Returns:
- the number of child nodes that this node holds.
-
ensureChildNodes
protected java.util.List<Node> ensureChildNodes()
- Specified by:
ensureChildNodes
in classNode
-
-