org.jsoup.nodes

Class TextNode

java.lang.Object

org.jsoup.nodes.Node

org.jsoup.nodes.LeafNode

org.jsoup.nodes.TextNode

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

CDataNode

public class TextNode
extends LeafNode

A text node.

Field Summary

Fields inherited from class org.jsoup.nodes.LeafNode

value

Fields inherited from class org.jsoup.nodes.Node

EmptyString, parentNode, siblingIndex

Constructor Summary

Constructors

Constructor and Description
TextNode(java.lang.String text) Create a new TextNode representing the supplied (unencoded) text).
TextNode(java.lang.String text, java.lang.String baseUri) Deprecated. use TextNode(String)

Method Summary

Modifier and Type	Method and Description
static TextNode	createFromEncoded(java.lang.String encodedText) Create a new TextNode from HTML encoded (aka escaped) data.
static TextNode	createFromEncoded(java.lang.String encodedText, java.lang.String baseUri) Deprecated. use createFromEncoded(String) instead, as LeafNodes don't carry base URIs.
java.lang.String	getWholeText() Get the (unencoded) text of this text node, including any newlines and spaces present in the original.
boolean	isBlank() Test if this text node is blank -- that is, empty or only whitespace (including newlines).
(package private) static boolean	lastCharIsWhitespace(java.lang.StringBuilder sb)
java.lang.String	nodeName() Get the node name of this node.
(package private) static java.lang.String	normaliseWhitespace(java.lang.String text)
(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)
TextNode	splitText(int offset) Split this text node into two nodes at the specified string offset.
(package private) static java.lang.String	stripLeadingWhitespace(java.lang.String text)
java.lang.String	text() Get the text content of this text node.
TextNode	text(java.lang.String text) Set the text content of this text node.
java.lang.String	toString()

Methods inherited from class org.jsoup.nodes.LeafNode

absUrl, attr, attr, attributes, baseUri, childNodeSize, coreValue, coreValue, doSetBaseUri, ensureChildNodes, hasAttr, hasAttributes, removeAttr

Methods inherited from class org.jsoup.nodes.Node

addChildren, addChildren, after, after, before, before, childNode, childNodes, childNodesAsArray, childNodesCopy, clearAttributes, clone, doClone, equals, filter, getOutputSettings, 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

Constructor Detail

TextNode

public TextNode(java.lang.String text)

Create a new TextNode representing the supplied (unencoded) text).

Parameters:

text - raw text

See Also:

createFromEncoded(String)

TextNode

public TextNode(java.lang.String text,
                java.lang.String baseUri)

Deprecated. use TextNode(String)

Create a new TextNode representing the supplied (unencoded) text).

Parameters:

text - raw text

baseUri - base uri - ignored for this node type

See Also:

createFromEncoded(String, String)

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

text

public java.lang.String text()

Get the text content of this text node.

Returns:

Unencoded, normalised text.

See Also:

getWholeText()

text

public TextNode text(java.lang.String text)

Set the text content of this text node.

Parameters:

text - unencoded text

Returns:

this, for chaining

getWholeText

public java.lang.String getWholeText()

Get the (unencoded) text of this text node, including any newlines and spaces present in the original.

Returns:

text

isBlank

public boolean isBlank()

Test if this text node is blank -- that is, empty or only whitespace (including newlines).

Returns:

true if this document is empty or only whitespace, false if it contains any text content.

splitText

public TextNode splitText(int offset)

Split this text node into two nodes at the specified string offset. After splitting, this node will contain the original text up to the offset, and will have a new text node sibling containing the text after the offset.

Parameters:

offset - string offset point to split node at.

Returns:

the newly created text node containing the text after the offset.

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

Overrides:

toString in class Node

createFromEncoded

public static TextNode createFromEncoded(java.lang.String encodedText,
                                         java.lang.String baseUri)

Deprecated. use createFromEncoded(String) instead, as LeafNodes don't carry base URIs.

Create a new TextNode from HTML encoded (aka escaped) data.

Parameters:

encodedText - Text containing encoded HTML (e.g. <)

baseUri - Base uri

Returns:

TextNode containing unencoded data (e.g. <)

createFromEncoded

public static TextNode createFromEncoded(java.lang.String encodedText)

Create a new TextNode from HTML encoded (aka escaped) data.

Parameters:

encodedText - Text containing encoded HTML (e.g. &lt;)

Returns:

TextNode containing unencoded data (e.g. <)

normaliseWhitespace

static java.lang.String normaliseWhitespace(java.lang.String text)

stripLeadingWhitespace

static java.lang.String stripLeadingWhitespace(java.lang.String text)

lastCharIsWhitespace

static boolean lastCharIsWhitespace(java.lang.StringBuilder sb)