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

java.lang.Object
- cat.inspiracio.html.DocumentRecurser<Void>
- - cat.inspiracio.html.DocumentWriter

public class DocumentWriter
extends DocumentRecurser<Void>

Writes a document to a writer. Usage:

  DocumentWriter w=new DocumentWriter(writer);
  w.document(d);

A DocumentWriter can be used only once.

Constructor Summary

Constructors
Constructor and Description

DocumentWriter(Writer writer)

Constructors
Constructor and Description
`DocumentWriter(Writer writer)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected DocumentWriter`	`attribute(String key, String value)` Writes " key=\"value\".
`protected DocumentWriter`	`cdata(String s)` Escapes a string for inclusion in cdata and writes it as CDATA section.
`protected DocumentWriter`	`close(Element e)` Writes an element's closing tag.
`protected DocumentWriter`	`comment(String s)` Escape a string for inclusion in a comment and writes it.
`protected DocumentWriter`	`doctype(DocumentType type)` Always writes the HTML5 doctype "<!DOCTYPE html>".
`protected DocumentWriter`	`element(Element e)` Processes an element.
`protected boolean`	`needClosingTag(String tag)` In html5 for common browsers, does this tag need a separate closing tag, even if the element is empty? This methods return true for a, script, title, textarea.
`protected DocumentWriter`	`open(Element e)` Writes opening tag and the attributes.
`protected String`	`quote(String value)` Quotes a value so that it can be an attribute's value.
`protected void`	`script(Element element)` Writes a script element.
`protected DocumentWriter`	`text(String s)` Escapes & and gt; in a text and writes it.
`String`	`toString()`
`protected DocumentWriter`	`write(char c)` Writes a character directly to the writer, no escaping.
`DocumentWriter`	`write(String s)` Writes a string directly to the writer, no escaping.
`protected DocumentWriter`	`writeEscapeElement(String s)` Escapes a String for inserting in HTML elements.
`protected DocumentWriter`	`writeln()` Writes a new-line to the writer.
`DocumentWriter`	`writeln(char c)` Writes a string and new-line to the writer, no escaping.
`DocumentWriter`	`writeln(String s)` Writes a string and new-line to the writer, no escaping.

Methods inherited from class cat.inspiracio.html.DocumentRecurser
attribute, attributes, cdata, close, comment, document, documentURI, entity, entityReference, fragment, node, nodes, notation, open, processingInstruction, text

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

- Constructor Detail
  - DocumentWriter
```
public DocumentWriter(Writer writer)
```
    Parameters:
    
    writer - Writes to this writer.
- Method Detail
  - write
```
protected DocumentWriter write(char c)
                        throws IOException
```
    Writes a character directly to the writer, no escaping.
    
    Parameters:
    
    c - the char
    
    Returns:
    
    Returns this for fluent style.
    
    Throws:
    
    IOException - something wrong
  - write
```
public DocumentWriter write(String s)
                     throws IOException
```
    Writes a string directly to the writer, no escaping.
    
    Parameters:
    
    s - the string
    
    Returns:
    
    Returns this for fluent style.
    
    Throws:
    
    IOException - something wrong
  - writeln
```
public DocumentWriter writeln(String s)
                       throws IOException
```
    Writes a string and new-line to the writer, no escaping. This is a separate method so that subclasses can override it, for modifications like minimising or indenting.
    
    Parameters:
    
    s - the string
    
    Returns:
    
    Returns this for fluent style.
    
    Throws:
    
    IOException - something wrong
  - writeln
```
public DocumentWriter writeln(char c)
                       throws IOException
```
    Writes a string and new-line to the writer, no escaping.
    
    Parameters:
    
    c - the char
    
    Returns:
    
    Returns this for fluent style.
    
    Throws:
    
    IOException - something wrong
  - writeln
```
protected DocumentWriter writeln()
                          throws IOException
```
    Writes a new-line to the writer.
    
    Returns:
    
    Returns this for fluent style.
    
    Throws:
    
    IOException - something wrong
  - doctype
```
protected DocumentWriter doctype(DocumentType type)
                          throws IOException
```
    Always writes the HTML5 doctype "<!DOCTYPE html>".
    
    Overrides:
    
    doctype in class DocumentRecurser<Void>
    
    Parameters:
    
    type - Ignored.
    
    Returns:
    
    Returns this for fluent style.
    
    Throws:
    
    IOException - something wrong
  - element
```
protected DocumentWriter element(Element e)
                          throws Exception
```
    Processes an element. If it's a script element, calls script(e), otherwise super.element(e).
    
    Overrides:
    
    element in class DocumentRecurser<Void>
    
    Parameters:
    
    e - the element
    
    Returns:
    
    Returns this for fluent style.
    
    Throws:
    
    Exception - something wrong
  - script
```
protected void script(Element element)
               throws Exception
```
    Writes a script element. Script elements are special: They have no child elements except for text, and the text should not be escaped. In that way, the javascript program in there can have < > &.
    
    Parameters:
    
    element - Must be script and must have no children other than text.
    
    Throws:
    
    Exception - something wrong
  - open
```
protected DocumentWriter open(Element e)
                       throws Exception
```
    Writes opening tag and the attributes. If the element has no child nodes, the final ">" of the opening tag is not written, so that close(e) can write "/>" --- unless the element is one of the few elements that need a separate closing tag even if they have no children.
    
    Overrides:
    
    open in class DocumentRecurser<Void>
    
    Parameters:
    
    e - the element
    
    Returns:
    
    Returns this for fluent style.
    
    Throws:
    
    Exception - something wrong
  - attribute
```
protected DocumentWriter attribute(String key,
                                   String value)
                            throws Exception
```
    Writes " key=\"value\". In value, " is escaped to "&". If the value is null or empty, writes just the key.
    
    Overrides:
    
    attribute in class DocumentRecurser<Void>
    
    Parameters:
    
    key - the key
    
    value - the value
    
    Returns:
    
    Returns this for fluent style.
    
    Throws:
    
    Exception - something wrong
  - text
```
protected DocumentWriter text(String s)
                       throws Exception
```
    Escapes & and gt; in a text and writes it.
    
    Overrides:
    
    text in class DocumentRecurser<Void>
    
    Parameters:
    
    s - the text
    
    Returns:
    
    Returns this for fluent style.
    
    Throws:
    
    Exception - something wrong
  - close
```
protected DocumentWriter close(Element e)
                        throws IOException
```
    Writes an element's closing tag. If the element has no children, only writes "/gt;" --- unless the element is one of the few elements that need a separate closing tag even if they have no child elements.
    
    Overrides:
    
    close in class DocumentRecurser<Void>
    
    Parameters:
    
    e - the element
    
    Returns:
    
    Returns this for fluent style.
    
    Throws:
    
    IOException - something wrong
  - cdata
```
protected DocumentWriter cdata(String s)
                        throws Exception
```
    Escapes a string for inclusion in cdata and writes it as CDATA section. May write several CDATA section. For each "]]>" in the string, adds another cdata section.
    
    Overrides:
    
    cdata in class DocumentRecurser<Void>
    
    Parameters:
    
    s - the CData string
    
    Returns:
    
    Returns this for fluent style.
    
    Throws:
    
    IOException - something wrong
    
    Exception - something wrong
  - comment
```
protected DocumentWriter comment(String s)
                          throws Exception
```
    Escape a string for inclusion in a comment and writes it.
    
    Overrides:
    
    comment in class DocumentRecurser<Void>
    
    Parameters:
    
    s - the comment as string
    
    Returns:
    
    Returns this for fluent style.
    
    Throws:
    
    Exception - something wrong
  - writeEscapeElement
```
protected DocumentWriter writeEscapeElement(String s)
                                     throws IOException
```
    Escapes a String for inserting in HTML elements. Assumes that the encoding is UTF-8 and does not escape accents and so on. In detail, does:
    
    i c escapeElement(c) length(escapeElement(c))
    
    38 & & 5
    
    60 < < 4
    
    escaping
    
    Parameters:
    
    s - The string to escape.
    
    Returns:
    
    the document writer
    
    Throws:
    
    IOException - something wrong
  - needClosingTag
```
protected boolean needClosingTag(String tag)
```
    In html5 for common browsers, does this tag need a separate closing tag, even if the element is empty? This methods return true for a, script, title, textarea.
    
    Parameters:
    
    tag - the tag
    
    Returns:
    
    Does it need a closing tag?
  - quote
```
protected String quote(String value)
```
    Quotes a value so that it can be an attribute's value. Escapes " by " and encloses in ".
    
    Parameters:
    
    value - string to quote
    
    Returns:
    
    quoted string
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

escaping
i	c	escapeElement(c)	length(escapeElement(c))
38	&	&	5
60	<	<	4

Class DocumentWriter

Constructor Summary

Method Summary

Methods inherited from class cat.inspiracio.html.DocumentRecurser

Methods inherited from class java.lang.Object

Constructor Detail

DocumentWriter

Method Detail

write

write

writeln

writeln

writeln

doctype

element

script

open

attribute

text

close

cdata

comment

writeEscapeElement

needClosingTag

quote

toString