com.jaunt

Class Element

java.lang.Object

com.jaunt.Node

com.jaunt.Element

Direct Known Subclasses:

Document, Elements

public class Element
extends Node

Represents an HTML, XHTML, or XML Element. An Element has an element name (ie the tagname) and may contain attributes (<elementName attributename='attributeValue'>). An element may also have one or more children (which can be other Elements, Comments, or Text), and a single parent. When two elements share the same parent, they are said to be sibling elements with respect to each other. The term "ancestor" refers to any element that rests at or above the level of the element's parent, and the term "descendant" refers to any element at or beneath the level of the element's child/children.

Since:

0.9.0

Author:

Tom Cervenka

Field Summary

Fields inherited from class com.jaunt.Node

COMMENT_TYPE, DOCUMENT_TYPE, ELEMENT_TYPE, TEXT_TYPE

Constructor Summary

Constructors

Constructor and Description
Element(String markup) Constructs an Element (as well as child/descendant nodes) that represents the specified HTML/XHTML/XML markup; if the specified markup consists of multiple elements at the topmost level, all but the first are ignored.
Element(String name, List<Node> children) Constructor

Method Summary

Modifier and Type	Method and Description
void	addChild(Node node) Adds the specified Node as a child after the last existing child.
void	addChildren(int index, List<Node> nodes) Inserts the specified Nodes at the specified index (any elements at that position are shifted down).
void	erase() Removes this element but not this element's children; the children are inserted into this element's parent, starting at the position formerly occupied by this element.
List<String>	findAttributeValues(String query) Searches all child/descendant elements and retrieves all attribute values that were found to match the query; example queries: "<a href>" (finds all href values in anchor tags), "<img src='http:.*'>" (find all image urls starting with 'http:'), "< id>" (finds all id values in tags of any name).
List<Comment>	findEach(short commentType) Searches all children/descendants and returns all Comments matching the specified Comment type constant (CDATA sections, processing instructions, and DOCTYPE definitions are treated as types of Comment).
Elements	findEach(String query) Searches child/descendant elements and retrieves elements that were found to match the query, not including those elements that are children/descendants of any matching elements.
Elements	findEvery(String query) Searches all child/descendant elements and retrieves all elements that were found to match the query.
Comment	findFirst(short commentType) Searches all children/descendants and returns the first Comment matching the specified Comment type constant (CDATA sections, processing instructions, and DOCTYPE definitions are treated as types of Comment).
Element	findFirst(String query) Searches all child/descendant elements and retrieves the first one found to match the query.
Element	findNearestAncestor(String tagNameRegex) Finds the nearest ancestor Element (working upwards from the current Element) whose tagname matches the specified case insensitive regular expression (using Matcher.matches()).
String	getAt(String attributeName) Returns the attribute value for the specified attributeName, or throws a NotFound Exception if the attribute name or attribute value is not found.
String	getAtString(String attributeName) Returns the attribute value for the specified (case insensitive) attribute name; returns an empty string rather than throwing an Exception if the attribute name or attribute value is not found.
List<String>	getAttributeNames() Retrieves a list of the attribute names.
List<Element>	getChildElements() Returns a list of child Elements, or an empty list if no child elements exist.
List<Node>	getChildNodes() Returns a list of child nodes; Attribute nodes are not included in the List.
String	getChildText() Returns a concatenation of all immediate Text children, or an empty String if none exist.
String	getChildText(boolean replaceEntities) Returns child text (a concatenation of all Text nodes that are immediate children), or an empty String if none exist.
Comment	getComment(int n) Retrieves the nth child Comment (CDATA sections, processing instructions, and DOCTYPE definitions are treated as types of Comment).
List<Comment>	getEach(short commentType) Searches only children (not all descendants) and returns all Comments matching the specified Comment type constant (CDATA sections, processing instructions, and DOCTYPE definitions are treated as types of Comment).
Elements	getEach(String query) Searches only child elements (not all descendants) and retrieves those that were found to match the query.
Element	getElement(int n) Retrieves the nth child Element or throws a NotFound Exception if no element exists at the specified position.
Comment	getFirst(short commentType) Searches only children (not all descendants) and returns the first Comment matching the specified Comment type constant (CDATA sections, processing instructions, and DOCTYPE definitions are treated as types of Comment).
Element	getFirst(String query) Searches only child elements (not all descendants) and retrieves the first child element that was found to match the query.
String	getInlineStyle(String attributeName) Returns the css value of the inline style associated with the specified css attribute name or null if no value exists.
Map<String,String>	getInlineStyles() Collects and returns a Map containing the inline styles from the style attribute (or an empty Map if no styles exist).
String	getName() Retrieves tagname normalized to lowercase.
String	getNameOC() Retrieves tagname in original case.
Element	getRoot() Returns the root ancestor Element (or Document container, if it exists).
int	getSiblingIndex() Retrieves the sibling index number of this Element (eg, if it's the first child element of its parent, it has index 0).
String	getTextContent() Returns the concatenation of all children/descendants of type Text, or an empty String if none exist.
String	getTextContent(String delimeter, boolean excludeScripts, boolean replaceEntities) Returns the concatenation of all children/descendants of type Text delimited by the specified delimiter.
String	getTextContent(String delimeter, Node startNode, Node endNode, boolean rangeInclusive, boolean includeComments, boolean excludeScripts, boolean replaceEntities) Returns the concatenation of all children/descendants of type Text delimited by the specified delimiter.
boolean	hasAttribute(String attributeName) Tests whether the specified attribute or keyword exists.
boolean	hasKeyword(String keyword) Returns a boolean value indicating whether the specified (case-insensitive) attribute is present, either as an attribute name or a keyword (ie an attribute name without an associated attribute value).
String	innerHTML() Returns a String representation of this element's children/descendant nodes as unformatted HTML.
String	innerHTML(int indents) Returns a String representation of this element's children/descendant nodes as formatted (ie indented) HTML.
void	innerHTML(String html) Replaces the contents of this element (ie the descendant nodes) with the specified HTML (or XHTML).
String	innerText() Deprecated. use getTextContent() instead.
String	innerText(String delimeter, boolean excludeScripts, boolean replaceEntities) Deprecated. use getTextContent(String, boolean, boolean) instead.
String	innerText(String delimeter, Node startNode, Node endNode, boolean rangeInclusive, boolean includeComments, boolean excludeScripts, boolean replaceEntities) Deprecated. use getTextContent(String, Node, Node, boolean, boolean, boolean, boolean) instead.
String	innerXML() Returns a String representation of this element's children/descendant nodes as unformatted XML.
String	innerXML(int indents) Returns a String representation of this element's children/descendant nodes as formatted (ie indented) XML.
void	innerXML(String xml) Replaces the contents of this element (ie the descendant nodes) with the specified XML, which is parsed in a matter that ignores the default HTML/XHTML DTD.
Element	nextSiblingElement() Retrieves the next sibling Element in the DOM (ie, the next Element that shares the same parent); note that this method is not suitable for iterating through the children of an Elements container, since the those elements may not be siblings in the dom tree.
String	outerHTML() Returns a String representation of this element (including its children/descendant nodes) as unformatted (ie unindented) HTML.
String	outerHTML(int indents) Returns a String representation of this element as formatted (ie indented) HTML, including its children/descendants.
String	outerXML() Returns a String representation of this element (including its children/descendant nodes) as unformatted (ie unindented) XML.
String	outerXML(int indents) Returns a String representation of this element (including its children/descendant nodes) as formatted (ie indented) XML.
com.jaunt.Attribute	removeAttribute(String attName) Removes the specified attribute or keyword.
void	removeAttributes() Removes all attributes.
boolean	removeChild(Node node) Removes the specified Node and sets the parent property of the removed Node to null.
void	removeChildren() Removes all child nodes and sets their parent property to null.
void	saveAs(String filename) Saves the current element and it's children/descendants as (UTF-8) HTML in the file specified by the relative filepath.
void	saveAsXML(String filename) Saves the current element and it's children/descendants as (UTF-8) XML in the file specified by the relative filepath.
void	setAttribute(String attributeName, String attributeValue) Adds a new attribute name and attribute value or associates an existing attribute name with a new attribute value.
String	toString() Creates a string representation of the current Element as an HTML tag (not including its children/descendants or counterpart closing tag).
String	toXMLString() Creates a string representation of the current Element as an XML tag (but not including its children/descendants).

Methods inherited from class com.jaunt.Node

delete, findNearestCommonAncestor, getParent, getType, isAfter, isBefore, isBetween, isBetween, nextNode, nextNodeSibling, nextNonDescendantNode, previousNode, previousNodeSibling, typeToString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Element

public Element(String markup)
        throws NotFound

Constructs an Element (as well as child/descendant nodes) that represents the specified HTML/XHTML/XML markup; if the specified markup consists of multiple elements at the topmost level, all but the first are ignored.

Throws:

NotFound

Element

public Element(String name,
               List<Node> children)

Constructor

Parameters:

name - tagname.

children - list of child Node objects or null

Method Detail

getName

public String getName()

Retrieves tagname normalized to lowercase.

getNameOC

public String getNameOC()

Retrieves tagname in original case.

getRoot

public Element getRoot()

Returns the root ancestor Element (or Document container, if it exists).

Returns:

the ancestor Element who's parent is null;

findNearestAncestor

public Element findNearestAncestor(String tagNameRegex)
                            throws NotFound

Finds the nearest ancestor Element (working upwards from the current Element) whose tagname matches the specified case insensitive regular expression (using Matcher.matches()).

Parameters:

tagNameRegex - case insensitive regular expression for matching the tagname.

Returns:

matching ancestor Element or throws a SearchException if none found.

Throws:

NotFound

nextSiblingElement

public Element nextSiblingElement()
                           throws NotFound

Retrieves the next sibling Element in the DOM (ie, the next Element that shares the same parent); note that this method is not suitable for iterating through the children of an Elements container, since the those elements may not be siblings in the dom tree.

Returns:

next sibling in the DOM that is an Element, or throws a NotFound Exception if none exists.

Throws:

NotFound

getSiblingIndex

public int getSiblingIndex()

Retrieves the sibling index number of this Element (eg, if it's the first child element of its parent, it has index 0).

Returns:

the sibling index number of this Element, where only Element children are indexed, with indexing starting at 0, or returns -1 if the element has no parent.

addChild

public void addChild(Node node)

Adds the specified Node as a child after the last existing child.

addChildren

public void addChildren(int index,
                        List<Node> nodes)

Inserts the specified Nodes at the specified index (any elements at that position are shifted down).

See Also:

innerHTML(String), innerXML(String)

removeChild

public boolean removeChild(Node node)

Removes the specified Node and sets the parent property of the removed Node to null.

Returns:

whether or not the specified Node was found.

removeChildren

public void removeChildren()

Removes all child nodes and sets their parent property to null.

getChildElements

public List<Element> getChildElements()

Returns a list of child Elements, or an empty list if no child elements exist.

getChildNodes

public List<Node> getChildNodes()

Returns a list of child nodes; Attribute nodes are not included in the List.

getComment

public Comment getComment(int n)
                   throws NotFound

Retrieves the nth child Comment (CDATA sections, processing instructions, and DOCTYPE definitions are treated as types of Comment).

Parameters:

n - the index (starting at 0) of the child Comment to return

Returns:

the child Comment or throws a NotFound Exception if none exists at the specified position.

Throws:

NotFound

getFirst

public Comment getFirst(short commentType)
                 throws NotFound

Searches only children (not all descendants) and returns the first Comment matching the specified Comment type constant (CDATA sections, processing instructions, and DOCTYPE definitions are treated as types of Comment).

Parameters:

commentType - Comment type constant or -1 to match any comment Type

Throws:

NotFound

getEach

public List<Comment> getEach(short commentType)

Searches only children (not all descendants) and returns all Comments matching the specified Comment type constant (CDATA sections, processing instructions, and DOCTYPE definitions are treated as types of Comment).

Parameters:

commentType - Comment type constant or -1 to match any comment Type

findFirst

public Comment findFirst(short commentType)
                  throws NotFound

Searches all children/descendants and returns the first Comment matching the specified Comment type constant (CDATA sections, processing instructions, and DOCTYPE definitions are treated as types of Comment).

Parameters:

commentType - Comment type constant or -1 to match any comment Type

Throws:

NotFound

findEach

public List<Comment> findEach(short commentType)

Searches all children/descendants and returns all Comments matching the specified Comment type constant (CDATA sections, processing instructions, and DOCTYPE definitions are treated as types of Comment).

Parameters:

commentType - Comment type constant or -1 to match any comment Type

getElement

public Element getElement(int n)
                   throws NotFound

Retrieves the nth child Element or throws a NotFound Exception if no element exists at the specified position.

Parameters:

n - the index (starting at 0) of the child Element to return

Returns:

the child element.

Throws:

NotFound

getFirst

public Element getFirst(String query)
                 throws NotFound

Searches only child elements (not all descendants) and retrieves the first child element that was found to match the query.

Parameters:

query - a query that has the general form <tagnameRegex attributeName="attributeValueRegex">childTextRegex where multiple attributes are allowed. In order for the query to match against an element, the tagnameRegex, attribute name, attributeValueRegex and immediateTextRegex must match if they are specified.
tagnameRegex: If tagnameRegex is a whitespace character, it will match any tagname. Otherwise, the tagnameRegex will be treated as case-insensitive and be evaluated against entire tagnames (ie will not match substrings). The tagnameRegex must begin with either an alphabetical character or a round opening bracket, and may not contain whitespace (though it may contain \\s, which matches whitespace)
attributeName: If no attributes are included in the query, the query will match any attributes in a candidate element (including one without attributes). Otherwise, the attributeName in the query is matched as a case-insensitive string, not as a regular expression.
attributeValueRegex: If attributeValueRegex is not present, the attributeName in the query will be matched against candidate attributeNames irrespective of their attributeValues. If attributeValueRegex is present, it will be treated as case-insensitive and be evaluated against the entire corresponding attribute value (ie will not match substrings).
childTextRegex: If childTextRegex is not present, the query will match any child text (including lack of text). Otherwise, childTextRegex will be evaluated against the concatenation of Text children of the Element (ie, not the concatenation of all Text descendants, just children). It's important to note that childTextRegex is case sensitive and by default does match against substrings since it uses Matcher.find().

Returns:

first child that matches the query, or throws a NotFound Exception if one is not found.

Throws:

NotFound

getEach

public Elements getEach(String query)

Searches only child elements (not all descendants) and retrieves those that were found to match the query.

Parameters:

query - a query that has the general form <tagnameRegex attributeName="attributeValueRegex">childTextRegex where multiple attributes are allowed. In order for the query to match against an element, the tagnameRegex, attribute name, attributeValueRegex and immediateTextRegex must match if they are specified.
tagnameRegex: If tagnameRegex is a whitespace character, it will match any tagname. Otherwise, the tagnameRegex will be treated as case-insensitive and be evaluated against entire tagnames (ie will not match substrings). The tagnameRegex must begin with either an alphabetical character or a round opening bracket, and may not contain whitespace (though it may contain \\s, which matches whitespace)
attributeName: If no attributes are included in the query, the query will match any attributes in a candidate element (including one without attributes). Otherwise, the attributeName in the query is matched as a case-insensitive string, not as a regular expression.
attributeValueRegex: If attributeValueRegex is not present, the attributeName in the query will be matched against candidate attributeNames irrespective of their attributeValues. If attributeValueRegex is present, it will be treated as case-insensitive and be evaluated against the entire corresponding attribute value (ie will not match substrings).
childTextRegex: If childTextRegex is not present, the query will match any child text (including lack of text). Otherwise, childTextRegex will be evaluated against the concatenation of Text children of the Element (ie, not the concatenation of all Text descendants, just children). It's important to note that childTextRegex is case sensitive and by default does match against substrings since it uses Matcher.find().

Returns:

a container of type Elements holding the elements that were found by the search.

findFirst

public Element findFirst(String query)
                  throws NotFound

Searches all child/descendant elements and retrieves the first one found to match the query.

Parameters:

query - a query that has the general form <tagnameRegex attributeName="attributeValueRegex">childTextRegex where multiple attributes are allowed. In order for the query to match against an element, the tagnameRegex, attribute name, attributeValueRegex and immediateTextRegex must match if they are specified.
tagnameRegex: If tagnameRegex is a whitespace character, it will match any tagname. Otherwise, the tagnameRegex will be treated as case-insensitive and be evaluated against entire tagnames (ie will not match substrings). The tagnameRegex must begin with either an alphabetical character or a round opening bracket, and may not contain whitespace (though it may contain \\s, which matches whitespace)
attributeName: If no attributes are included in the query, the query will match any attributes in a candidate element (including one without attributes). Otherwise, the attributeName in the query is matched as a case-insensitive string, not as a regular expression.
attributeValueRegex: If attributeValueRegex is not present, the attributeName in the query will be matched against candidate attributeNames irrespective of their attributeValues. If attributeValueRegex is present, it will be treated as case-insensitive and be evaluated against the entire corresponding attribute value (ie will not match substrings).
childTextRegex: If childTextRegex is not present, the query will match any child text (including lack of text). Otherwise, childTextRegex will be evaluated against the concatenation of Text children of the Element (ie, not the concatenation of all Text descendants, just children). It's important to note that childTextRegex is case sensitive and by default does match against substrings since it uses Matcher.find().

Returns:

first child that matches the specified parameters, or throws a NotFound Exception if one is not found.

Throws:

NotFound

findEach

public Elements findEach(String query)

Searches child/descendant elements and retrieves elements that were found to match the query, not including those elements that are children/descendants of any matching elements.

Parameters:

query - a query that has the general form <tagnameRegex attributeName="attributeValueRegex">childTextRegex where multiple attributes are allowed. In order for the query to match against an element, the tagnameRegex, attribute name, attributeValueRegex and immediateTextRegex must match if they are specified.
tagnameRegex: If tagnameRegex is a whitespace character, it will match any tagname. Otherwise, the tagnameRegex will be treated as case-insensitive and be evaluated against entire tagnames (ie will not match substrings). The tagnameRegex must begin with either an alphabetical character or a round opening bracket, and may not contain whitespace (though it may contain \\s, which matches whitespace)
attributeName: If no attributes are included in the query, the query will match any attributes in a candidate element (including one without attributes). Otherwise, the attributeName in the query is matched as a case-insensitive string, not as a regular expression.
attributeValueRegex: If attributeValueRegex is not present, the attributeName in the query will be matched against candidate attributeNames irrespective of their attributeValues. If attributeValueRegex is present, it will be treated as case-insensitive and be evaluated against the entire corresponding attribute value (ie will not match substrings).
childTextRegex: If childTextRegex is not present, the query will match any child text (including lack of text). Otherwise, childTextRegex will be evaluated against the concatenation of Text children of the Element (ie, not the concatenation of all Text descendants, just children). It's important to note that childTextRegex is case sensitive and by default does match against substrings since it uses Matcher.find().

Returns:

a container of type Elements holding the elements that were found as a result of the search.

findEvery

public Elements findEvery(String query)

Searches all child/descendant elements and retrieves all elements that were found to match the query.

Parameters:

query - a query that has the general form <tagnameRegex attributeName="attributeValueRegex">childTextRegex where multiple attributes are allowed. In order for the query to match against an element, the tagnameRegex, attribute name, attributeValueRegex and immediateTextRegex must match if they are specified.
tagnameRegex: If tagnameRegex is a whitespace character, it will match any tagname. Otherwise, the tagnameRegex will be treated as case-insensitive and be evaluated against entire tagnames (ie will not match substrings). The tagnameRegex must begin with either an alphabetical character or a round opening bracket, and may not contain whitespace (though it may contain \\s, which matches whitespace)
attributeName: If no attributes are included in the query, the query will match any attributes in a candidate element (including one without attributes). Otherwise, the attributeName in the query is matched as a case-insensitive string, not as a regular expression.
attributeValueRegex: If attributeValueRegex is not present, the attributeName in the query will be matched against candidate attributeNames irrespective of their attributeValues. If attributeValueRegex is present, it will be treated as case-insensitive and be evaluated against the entire corresponding attribute value (ie will not match substrings).
childTextRegex: If childTextRegex is not present, the query will match any child text (including lack of text). Otherwise, childTextRegex will be evaluated against the concatenation of Text children of the Element (ie, not the concatenation of all Text descendants, just children). It's important to note that childTextRegex is case sensitive and by default does match against substrings since it uses Matcher.find().

Returns:

a container of type Elements holding the elements that were found as a result of the search.

getAttributeNames

public List<String> getAttributeNames()

Retrieves a list of the attribute names.

Returns:

a list containing the attribute names in lowercase.

getAtString

public String getAtString(String attributeName)

Returns the attribute value for the specified (case insensitive) attribute name; returns an empty string rather than throwing an Exception if the attribute name or attribute value is not found.

Parameters:

attributeName - case insensitive attribute name.

Returns:

the attribute value, with entity references converted to regular (String) characters, or an empty string if the attribute value was not found.

See Also:

getAt(String)

hasKeyword

public boolean hasKeyword(String keyword)

Returns a boolean value indicating whether the specified (case-insensitive) attribute is present, either as an attribute name or a keyword (ie an attribute name without an associated attribute value).

getAt

public String getAt(String attributeName)
             throws NotFound

Returns the attribute value for the specified attributeName, or throws a NotFound Exception if the attribute name or attribute value is not found.

Parameters:

attributeName - case insensitive attribute name.

Returns:

attribute value or null if attribute name (or value) does not exist.

Throws:

NotFound

See Also:

getAtString(String)

setAttribute

public void setAttribute(String attributeName,
                         String attributeValue)

Adds a new attribute name and attribute value or associates an existing attribute name with a new attribute value.

Parameters:

attributeName - the attribute name.

attributeValue - the attribute value.

removeAttribute

public com.jaunt.Attribute removeAttribute(String attName)

Removes the specified attribute or keyword.

Parameters:

attName - the case insensitive name of the attribute (or keyword) to be removed and returned.

Returns:

the Attribute object associated with the specified attribute name or null if none exists.

removeAttributes

public void removeAttributes()

Removes all attributes.

hasAttribute

public boolean hasAttribute(String attributeName)

Tests whether the specified attribute or keyword exists.

Parameters:

attributeName - case insensitive attribute name or keyword.

Returns:

boolean indicating whether the attribute/keyword exists.

getInlineStyle

public String getInlineStyle(String attributeName)

Returns the css value of the inline style associated with the specified css attribute name or null if no value exists.

Parameters:

attributeName - the case insensitive css attribute name.

Returns:

the css value of the specified css attribute name.

getInlineStyles

public Map<String,String> getInlineStyles()

Collects and returns a Map containing the inline styles from the style attribute (or an empty Map if no styles exist).

Returns:

Map where the keys are (lowercase) css attribute names and the values are css values.

erase

public void erase()

Removes this element but not this element's children; the children are inserted into this element's parent, starting at the position formerly occupied by this element. Does nothing if this element has no parent.

See Also:

Node.delete()

saveAs

public void saveAs(String filename)
            throws IOException

Saves the current element and it's children/descendants as (UTF-8) HTML in the file specified by the relative filepath. This method is intended for quick-and-dirty saves while debugging.

Parameters:

filename - the path/filename relative to system property user.dir (the current working directory).

Throws:

IOException

saveAsXML

public void saveAsXML(String filename)
               throws IOException

Saves the current element and it's children/descendants as (UTF-8) XML in the file specified by the relative filepath. This method is intended for quick-and-dirty saves while debugging.

Parameters:

filename - the path/filename relative to system property user.dir (the current working directory).

Throws:

IOException

getChildText

public String getChildText()

Returns a concatenation of all immediate Text children, or an empty String if none exist.

Returns:

immediate child text Nodes as a String.

getChildText

public String getChildText(boolean replaceEntities)

Returns child text (a concatenation of all Text nodes that are immediate children), or an empty String if none exist.

Parameters:

replaceEntities - whether to replace entity references with character equivalents.

getTextContent

public String getTextContent()

Returns the concatenation of all children/descendants of type Text, or an empty String if none exist.

Returns:

child/descendant text Nodes as a String.

innerText

@Deprecated
public String innerText()

Deprecated. use getTextContent() instead.

Returns the concatenation of all children/descendants of type Text, or an empty String if none exist.

Returns:

child/descendant text Nodes as a String.

getTextContent

public String getTextContent(String delimeter,
                             boolean excludeScripts,
                             boolean replaceEntities)

Returns the concatenation of all children/descendants of type Text delimited by the specified delimiter.

Parameters:

delimeter - a delimeter insert between each text when concatenating, or null for no delimeter

excludeScripts - whether to exclude any text content of script tags.

replaceEntities - whether to replace entity references with character equivalents.

Returns:

concatenation of child/descendant text Nodes as a String or an empty string if none exit.

innerText

@Deprecated
public String innerText(String delimeter,
                                     boolean excludeScripts,
                                     boolean replaceEntities)

Deprecated. use getTextContent(String, boolean, boolean) instead.

Returns the concatenation of all children/descendants of type Text delimited by the specified delimiter.

Parameters:

delimeter - a delimeter insert between each text when concatenating, or null for no delimeter

excludeScripts - whether to exclude any text content of script tags.

replaceEntities - whether to replace entity references with character equivalents.

Returns:

concatenation of child/descendant text Nodes as a String or an empty string if none exit.

getTextContent

public String getTextContent(String delimeter,
                             Node startNode,
                             Node endNode,
                             boolean rangeInclusive,
                             boolean includeComments,
                             boolean excludeScripts,
                             boolean replaceEntities)

Returns the concatenation of all children/descendants of type Text delimited by the specified delimiter.

Parameters:

delimeter - a delimeter insert between each text when concatenating, or null for no delimeter

startNode - the node at which text concatenation begins, or null not to speciy a start node.

endNode - the node at which text concatenation ends, or null not to speciy an end node.

rangeInclusive - whether to concatenate the innerText start and end node, or only the nodes between.

includeComments - whether to include text occuring within HTML/XML comments.

excludeScripts - whether to exclude any text content of script tags.

replaceEntities - whether to replace entity references with character equivalents.

Returns:

concatenation o child/descendant text Nodes as a String or an empty string if none exit.

innerText

@Deprecated
public String innerText(String delimeter,
                                     Node startNode,
                                     Node endNode,
                                     boolean rangeInclusive,
                                     boolean includeComments,
                                     boolean excludeScripts,
                                     boolean replaceEntities)

Deprecated. use getTextContent(String, Node, Node, boolean, boolean, boolean, boolean) instead.

Returns the concatenation of all children/descendants of type Text delimited by the specified delimiter.

Parameters:

delimeter - a delimeter insert between each text when concatenating, or null for no delimeter

startNode - the node at which text concatenation begins, or null not to speciy a start node.

endNode - the node at which text concatenation ends, or null not to speciy an end node.

rangeInclusive - whether to concatenate the innerText start and end node, or only the nodes between.

includeComments - whether to include text occuring within HTML/XML comments.

excludeScripts - whether to exclude any text content of script tags.

replaceEntities - whether to replace entity references with character equivalents.

Returns:

concatenation of child/descendant text Nodes as a String or an empty string if none exit.

toString

public String toString()

Creates a string representation of the current Element as an HTML tag (not including its children/descendants or counterpart closing tag).

Overrides:

toString in class Object

Returns:

an HTML representation of this element (not including its children).

See Also:

outerHTML()

toXMLString

public String toXMLString()

Creates a string representation of the current Element as an XML tag (but not including its children/descendants).

Returns:

an XML representation of this element (not including its children).

See Also:

outerXML()

outerHTML

public String outerHTML()

Returns a String representation of this element (including its children/descendant nodes) as unformatted (ie unindented) HTML.

outerHTML

public String outerHTML(int indents)

Returns a String representation of this element as formatted (ie indented) HTML, including its children/descendants.

Parameters:

indents - the number of whitespace characters to use per indent.

innerHTML

public String innerHTML()

Returns a String representation of this element's children/descendant nodes as unformatted HTML.

innerHTML

public String innerHTML(int indents)

Returns a String representation of this element's children/descendant nodes as formatted (ie indented) HTML.

Parameters:

indents - the number of whitespace characters to use per indent.

innerHTML

public void innerHTML(String html)

Replaces the contents of this element (ie the descendant nodes) with the specified HTML (or XHTML).

outerXML

public String outerXML()

Returns a String representation of this element (including its children/descendant nodes) as unformatted (ie unindented) XML.

outerXML

public String outerXML(int indents)

Returns a String representation of this element (including its children/descendant nodes) as formatted (ie indented) XML.

Parameters:

indents - the number of whitespace characters to use per indent.

innerXML

public String innerXML()

Returns a String representation of this element's children/descendant nodes as unformatted XML.

innerXML

public String innerXML(int indents)

Returns a String representation of this element's children/descendant nodes as formatted (ie indented) XML.

Parameters:

indents - the number of whitespace characters to use per indent.

innerXML

public void innerXML(String xml)

Replaces the contents of this element (ie the descendant nodes) with the specified XML, which is parsed in a matter that ignores the default HTML/XHTML DTD.

findAttributeValues

public List<String> findAttributeValues(String query)

Searches all child/descendant elements and retrieves all attribute values that were found to match the query; example queries: "<a href>" (finds all href values in anchor tags), "<img src='http:.*'>" (find all image urls starting with 'http:'), "< id>" (finds all id values in tags of any name).

Parameters:

query - a query that has the general form <tagnameRegex attributeName="attributeValueRegex">. In order for the query to match against an attribute value, the tagnameRegex, attribute name, and attributeValueRegex must match if they are specified.
tagnameRegex: If tagnameRegex is a whitespace character, it will match any tagname. Otherwise, the tagnameRegex will be treated as case-insensitive and be evaluated against candidate tagnames (using Matcher.matches()). The tagnameRegex must begin with either an alphabetical character or a round opening bracket, and may not contain whitespace (though it may contain \\s, which matches whitespace)
attributeName: The attributeName in the query is matched as a case-insensitive string, not as a regular expression. Whenever the entire query matches a candidate element, the value of the first attribute in candidate is extracted and placed into the search results List.
attributeValueRegex: If attributeValueRegex is not present, the attributeName in the query will be matched against candidate attributeNames irrespective of their attributeValues. If attributeValueRegex is present, it will be treated as case-insensitive and be matched against candidate attribute values (using Matcher.matches()).

Returns:

a List<String> holding the attribute values that matched the query.