DocumentRecurser (cat.inspiracio:html-parser 0.0.3 API)

java.lang.Object
- cat.inspiracio.html.DocumentRecurser<T>

Type Parameters:

T - is the type of the outcome, returned by close(Document).

Direct Known Subclasses:

DocumentWriter
```
public class DocumentRecurser<T>
extends Object
```
Recurses over a document. Subclasses can do interesting things on the way. There is a method for each of the objects in a document. All methods declare Exception so that they can throw anything. Alternative: parametrise exception type. But then there can be only one exception type.

Constructor Summary

Constructors
Constructor and Description

DocumentRecurser()

Constructors
Constructor and Description
`DocumentRecurser()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected DocumentRecurser<T>`	`attribute(Attr a)` Processes an attribute.
`protected DocumentRecurser<T>`	`attribute(String key, String value)` Processes an attribute.
`protected DocumentRecurser<T>`	`attributes(Element e)` Processes the attributes of an element.
`protected DocumentRecurser<T>`	`cdata(CDATASection cd)` Processes a CData section.
`protected DocumentRecurser<T>`	`cdata(String s)` Processes a cdata section.
`protected T`	`close(Document d)` Finishes processing the document and returns the result.
`protected DocumentRecurser<T>`	`close(Element e)` Processes the closing tag of an element.
`protected DocumentRecurser<T>`	`comment(Comment c)` Processes a Comment.
`protected DocumentRecurser<T>`	`comment(String s)` Processes a comment.
`protected DocumentRecurser<T>`	`doctype(DocumentType type)` Processes the doctype.
`T`	`document(Document d)` Processes a document and returns the result.
`protected DocumentRecurser<T>`	`documentURI(String uri)` Processes the document URI.
`protected DocumentRecurser<T>`	`element(Element e)` Processes an element.
`protected DocumentRecurser<T>`	`entity(Entity e)` Processes an entity.
`protected DocumentRecurser<T>`	`entityReference(EntityReference er)` Processes an entity reference.
`protected DocumentRecurser<T>`	`fragment(DocumentFragment f)` Processes a document fragment.
`protected DocumentRecurser<T>`	`node(Node n)` Processes a node.
`protected DocumentRecurser<T>`	`nodes(NodeList ns)` Processes a list of nodes.
`protected DocumentRecurser<T>`	`notation(Notation n)` Processes a notation node.
`protected DocumentRecurser<T>`	`open(Document d)` Prepares processing a document.
`protected DocumentRecurser<T>`	`open(Element e)` Processes the opening tag of an element.
`protected DocumentRecurser<T>`	`processingInstruction(ProcessingInstruction i)` Processes a processing instruction.
`protected DocumentRecurser<T>`	`text(String s)` Processes a text.
`protected DocumentRecurser<T>`	`text(Text t)` Processes a Text.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DocumentRecurser
```
public DocumentRecurser()
```
- Method Detail
  - document
```
public T document(Document d)
           throws Exception
```
    Processes a document and returns the result. This method calls
```
        open(d);
        doctype(d.getDoctype());
        documentURI(d.getDocumentURI());
        Element e=d.getDocumentElement();
        if(e!=null)
            element(e);
        return close(d);
 
```
    Parameters:
    
    d - the document
    
    Returns:
    
    the outcome
    
    Throws:
    
    Exception - something wrong
  - element
```
protected DocumentRecurser<T> element(Element e)
                               throws Exception
```
    Processes an element. This method calls
```
        open(e);
        nodes(e.getChildNodes());
        close(e);
 
```
    Parameters:
    
    e - the element
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - attributes
```
protected DocumentRecurser<T> attributes(Element e)
                                  throws Exception
```
    Processes the attributes of an element. This method calls
```
attribute(a)
```
    for each.
    Parameters:
    
    e - the element
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - attribute
```
protected DocumentRecurser<T> attribute(Attr a)
                                 throws Exception
```
    Processes an attribute. This method calls
```
attribute(a.getName(), a.getValue())
```
    Parameters:
    
    a - the attribute
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - text
```
protected DocumentRecurser<T> text(Text t)
                            throws Exception
```
    Processes a Text. This method calls
```
text(t.getData()).
```
    Parameters:
    
    t - the text
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - comment
```
protected DocumentRecurser<T> comment(Comment c)
                               throws Exception
```
    Processes a Comment. This method calls
```
comment(c.getData()).
```
    Parameters:
    
    c - the comment
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - cdata
```
protected DocumentRecurser<T> cdata(CDATASection cd)
                             throws Exception
```
    Processes a CData section. This method calls
```
cdata(cd.getData()).
```
    Parameters:
    
    cd - the CData
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - nodes
```
protected DocumentRecurser<T> nodes(NodeList ns)
                             throws Exception
```
    Processes a list of nodes. This method calls
```
node(n)
```
    for each.
    Parameters:
    
    ns - the node list
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - node
```
protected DocumentRecurser<T> node(Node n)
                            throws Exception
```
    Processes a node. This method discriminates by node type, casts, and calls the corresponding method.
    
    Parameters:
    
    n - the node
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - open
```
protected DocumentRecurser<T> open(Document d)
                            throws Exception
```
    Prepares processing a document. This methods does nothing.
    
    Parameters:
    
    d - the document
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - doctype
```
protected DocumentRecurser<T> doctype(DocumentType type)
                               throws Exception
```
    Processes the doctype. This methods does nothing.
    
    Parameters:
    
    type - the type
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - documentURI
```
protected DocumentRecurser<T> documentURI(String uri)
                                   throws Exception
```
    Processes the document URI. This methods does nothing.
    
    Parameters:
    
    uri - the document URI
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - close
```
protected T close(Document d)
           throws Exception
```
    Finishes processing the document and returns the result. This methods does nothing and returns null.
    
    Parameters:
    
    d - the document
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - open
```
protected DocumentRecurser<T> open(Element e)
                            throws Exception
```
    Processes the opening tag of an element. This method just calls
```
attributes(e).
```
    When you override, you must call attributes(e) yourself.
    Parameters:
    
    e - the element
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - close
```
protected DocumentRecurser<T> close(Element e)
                             throws Exception
```
    Processes the closing tag of an element. This method does nothing.
    
    Parameters:
    
    e - the element
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - attribute
```
protected DocumentRecurser<T> attribute(String key,
                                        String value)
                                 throws Exception
```
    Processes an attribute.
    
    Parameters:
    
    key - the key
    
    value - the value
    
    Returns:
    
    this, for fluent style
    
    Throws:
    
    Exception - something wrong
  - text
```
protected DocumentRecurser<T> text(String s)
                            throws Exception
```
    Processes a text. This method does nothing.
    
    Parameters:
    
    s - the text
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - cdata
```
protected DocumentRecurser<T> cdata(String s)
                             throws Exception
```
    Processes a cdata section. This methods does nothing.
    
    Parameters:
    
    s - the CData text
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - comment
```
protected DocumentRecurser<T> comment(String s)
                               throws Exception
```
    Processes a comment. This method does nothing.
    
    Parameters:
    
    s - the comment text
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - entity
```
protected DocumentRecurser<T> entity(Entity e)
                              throws Exception
```
    Processes an entity. This method does nothing.
    
    Parameters:
    
    e - the entity
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - entityReference
```
protected DocumentRecurser<T> entityReference(EntityReference er)
                                       throws Exception
```
    Processes an entity reference. This method does nothing.
    
    Parameters:
    
    er - the entity reference
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - notation
```
protected DocumentRecurser<T> notation(Notation n)
                                throws Exception
```
    Processes a notation node. This method does nothing.
    
    Parameters:
    
    n - the notation
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - processingInstruction
```
protected DocumentRecurser<T> processingInstruction(ProcessingInstruction i)
                                             throws Exception
```
    Processes a processing instruction. This method does nothing.
    
    Parameters:
    
    i - the processing instruction
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong
  - fragment
```
protected DocumentRecurser<T> fragment(DocumentFragment f)
                                throws Exception
```
    Processes a document fragment. This method processes the child nodes of the fragment.
    
    Parameters:
    
    f - the document fragment
    
    Returns:
    
    the recurser
    
    Throws:
    
    Exception - something wrong

Class DocumentRecurser<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentRecurser

Method Detail

document

element

attributes

attribute

text

comment

cdata

nodes

node

open

doctype

documentURI

close

open

close

attribute

text

cdata

comment

entity

entityReference

notation

processingInstruction

fragment