org.htmlparser.util

Class NodeList

public class NodeList extends Object implements Serializable

Constructor Summary
	NodeList()
	NodeList(Node node) Create a one element node list.

Method Summary
void	add(Node node)
void	add(NodeList list) Add another node list to this one.
String	asString()
boolean	contains(Node node) Check to see if the NodeList contains the supplied Node.
void	copyToNodeArray(Node[] array)
Node	elementAt(int i)
SimpleNodeIterator	elements()
NodeList	extractAllNodesThatMatch(NodeFilter filter) Filter the list with the given filter non-recursively.
NodeList	extractAllNodesThatMatch(NodeFilter filter, boolean recursive) Filter the list with the given filter.
int	indexOf(Node node) Finds the index of the supplied Node.
void	keepAllNodesThatMatch(NodeFilter filter) Remove nodes not matching the given filter non-recursively.
void	keepAllNodesThatMatch(NodeFilter filter, boolean recursive) Remove nodes not matching the given filter.
void	prepend(Node node) Insert the given node at the head of the list.
Node	remove(int index) Remove the node at index.
boolean	remove(Node node) Remove the supplied Node from the list.
void	removeAll()
int	size()
String	toHtml(boolean verbatim) Convert this nodelist into the equivalent HTML.
String	toHtml() Convert this nodelist into the equivalent HTML.
Node[]	toNodeArray()
String	toString() Return the contents of the list as a string.
void	visitAllNodesWith(NodeVisitor visitor) Utility to apply a visitor to a node list.

Constructor Detail

NodeList

public NodeList()

NodeList

public NodeList(Node node)

Create a one element node list.

Parameters: node The initial node to add.

Method Detail

add

public void add(Node node)

add

public void add(NodeList list)

Add another node list to this one.

Parameters: list The list to add.

asString

public String asString()

contains

public boolean contains(Node node)

Check to see if the NodeList contains the supplied Node.

Parameters: node The node to look for.

Returns: True is the Node is in this NodeList.

copyToNodeArray

public void copyToNodeArray(Node[] array)

elementAt

public Node elementAt(int i)

elements

public SimpleNodeIterator elements()

extractAllNodesThatMatch

public NodeList extractAllNodesThatMatch(NodeFilter filter)

Filter the list with the given filter non-recursively.

Parameters: filter The filter to use.

Returns: A new node array containing the nodes accepted by the filter. This is a linear list and preserves the nested structure of the returned nodes only.

extractAllNodesThatMatch

public NodeList extractAllNodesThatMatch(NodeFilter filter, boolean recursive)

Filter the list with the given filter.

Parameters: filter The filter to use. recursive If true digs into the children recursively.


Returns: A new node array containing the nodes accepted by the filter.
 This is a linear list and preserves the nested structure of the returned
 nodes only.




   indexOf
   public  int indexOf(Node node)
   
 Finds the index of the supplied Node.Parameters: node The node to look for. 
Returns: The index of the node in the list or -1 if it isn't found. 



   keepAllNodesThatMatch
   public  void keepAllNodesThatMatch(NodeFilter filter)
   
 Remove nodes not matching the given filter non-recursively.Parameters: filter The filter to use. 



   keepAllNodesThatMatch
   public  void keepAllNodesThatMatch(NodeFilter filter, boolean recursive)
   
 Remove nodes not matching the given filter.Parameters: filter The filter to use. recursive If true digs into the children recursively. 




   prepend
   public  void prepend(Node node)
   
 Insert the given node at the head of the list.Parameters: node The new first element. 



   remove
   public  Node remove(int index)
   
 Remove the node at index.Parameters: index The index of the node to remove. 
Returns: The node that was removed. 



   remove
   public  boolean remove(Node node)
   
 Remove the supplied Node from the list.Parameters: node The node to remove. 
Returns: True if the node was found and removed from the list. 



   removeAll
   public  void removeAll()
   


   size
   public  int size()
   


   toHtml
   public  String toHtml(boolean verbatim)
   
 Convert this nodelist into the equivalent HTML.Parameters: verbatim If true return as close to the original
 page text as possible. 
Returns: The contents of the list as HTML text. 



   toHtml
   public  String toHtml()
   
 Convert this nodelist into the equivalent HTML.Returns: The contents of the list as HTML text. 



   toNodeArray
   public  Node[] toNodeArray()
   


   toString
   public  String toString()
   
 Return the contents of the list as a string.
 Suitable for debugging.Returns: A string representation of the list. 



   visitAllNodesWith
   public  void visitAllNodesWith(NodeVisitor visitor)
   
 Utility to apply a visitor to a node list.
 Provides for a visitor to modify the contents of a page and get the
 modified HTML as a string with code like this:
  Parser parser = new Parser ("http://whatever");
 NodeList list = parser.parse (null); // no filter
 list.visitAllNodesWith (visitor);
 System.out.println (list.toHtml ());
 

   
   
    
      Overview
      Package
      Class
      Use
      Tree
      Deprecated
      Index
      Help
    
    
      
       Prev Class
       Next Class
      
      
       Frames
       NoFrames
      
      All Classes
   
   
      Summary:
       Nested
       Field
       Constr
       Method
      
      Detail:
       Field
       Constr
       Method
      
   
    
     © 2005 Derrick OswaldOct 06, 2008
    
    
   
   HTML Parser is an open source library released under     LGPL.