DocumentWriterImpl (fluent-xml-writer 1.0 API)

java.lang.Object
- foundation.fluent.api.xml.impl.DocumentWriterImpl

All Implemented Interfaces:: ContentWriter, DocumentWriter, DocumentWriter.DoctypeWriter, DocumentWriter.XmlSpecWriter, Supplier<ContentWriter>

public final class DocumentWriterImpl
extends Object
implements DocumentWriter.XmlSpecWriter, DocumentWriter.DoctypeWriter, Supplier<ContentWriter>

Nested Class Summary
- Nested classes/interfaces inherited from interface foundation.fluent.api.xml.DocumentWriter
  DocumentWriter.DoctypeWriter, DocumentWriter.XmlSpecWriter

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ContentWriter`	`cdata(String content)` Write CDATA content of the currently opened tag.
`void`	`close()` Close the XML document. 1.
`ContentWriter`	`comment(String comment)` Write XML comment into current position.
`DocumentWriter.DoctypeWriter`	`doctype(String name)` Write XML document type to associate document with DTD, ot set it as well known.
`static DocumentWriter`	`documentBuilder(Writer writer, DocumentWriterConfig config)`
`DocumentWriter.XmlSpecWriter`	`encoding(String encoding)` Write XML document encoding.
`ContentWriter`	`end()` End currently opened tag.
`DocumentWriter`	`flush()` Flush the content using underlying writer.
`ContentWriter`	`get()`
`DocumentWriter`	`instruction(String name, String content)` Write XML processing instruction.
`DocumentWriter.DoctypeWriter`	`publicDtd(String uri, String dtd)`
`DocumentWriter.DoctypeWriter`	`systemDtd(String dtd)`
`ElementWriter`	`tag(String tag)` Start writing opening tag with provided tag name.
`ElementWriter`	`tag(String nsPrefix, String tag)` Start writing opening tag with provided XML namespace prefix and tag name.
`ContentWriter`	`text(String content)` Write text content of the currently opened tag.
`DocumentWriter.XmlSpecWriter`	`version(String version)` Write XML document version.

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

Methods inherited from interface foundation.fluent.api.xml.DocumentWriter
version

- Method Detail
  - documentBuilder
```
public static DocumentWriter documentBuilder(Writer writer,
                                             DocumentWriterConfig config)
```
  - version
```
public DocumentWriter.XmlSpecWriter version(String version)
```
    Description copied from interface: DocumentWriter
    
    Write XML document version.
    
    Specified by:
    
    version in interface DocumentWriter
    
    Parameters:
    
    version - document version.
    
    Returns:
    
    Document writer to continue with its definition.
  - doctype
```
public DocumentWriter.DoctypeWriter doctype(String name)
```
    Description copied from interface: DocumentWriter
    
    Write XML document type to associate document with DTD, ot set it as well known.
    
    Specified by:
    
    doctype in interface DocumentWriter
    
    Parameters:
    
    name - Document type name.
    
    Returns:
  - publicDtd
```
public DocumentWriter.DoctypeWriter publicDtd(String uri,
                                              String dtd)
```
    Specified by:
    
    publicDtd in interface DocumentWriter.DoctypeWriter
  - systemDtd
```
public DocumentWriter.DoctypeWriter systemDtd(String dtd)
```
    Specified by:
    
    systemDtd in interface DocumentWriter.DoctypeWriter
  - flush
```
public DocumentWriter flush()
```
    Description copied from interface: DocumentWriter
    
    Flush the content using underlying writer.
    
    Specified by:
    
    flush in interface ContentWriter
    
    Specified by:
    
    flush in interface DocumentWriter
    
    Returns:
    
    this
  - encoding
```
public DocumentWriter.XmlSpecWriter encoding(String encoding)
```
    Description copied from interface: DocumentWriter.XmlSpecWriter
    
    Write XML document encoding.
    
    Specified by:
    
    encoding in interface DocumentWriter.XmlSpecWriter
    
    Parameters:
    
    encoding - document encoding.
    
    Returns:
    
    Document writer to continue with its definition.
  - instruction
```
public DocumentWriter instruction(String name,
                                  String content)
```
    Description copied from interface: ContentWriter
    
    Write XML processing instruction.
    
    Specified by:
    
    instruction in interface ContentWriter
    
    Parameters:
    
    name - Processing instruction name (e.g. xml-stylesheet).
    
    content - Content of the processing instruction tag.
    
    Returns:
    
    Writer to continue writing additional content.
  - tag
```
public ElementWriter tag(String tag)
```
    Description copied from interface: ContentWriter
    
    Start writing opening tag with provided tag name.
    
    Specified by:
    
    tag in interface ContentWriter
    
    Parameters:
    
    tag - Tag name.
    
    Returns:
    
    Writer of element content including it's attributes.
  - tag
```
public ElementWriter tag(String nsPrefix,
                         String tag)
```
    Description copied from interface: ContentWriter
    
    Start writing opening tag with provided XML namespace prefix and tag name.
    
    Specified by:
    
    tag in interface ContentWriter
    
    Parameters:
    
    nsPrefix - XML namespace prefix.
    
    tag - Tag name.
    
    Returns:
    
    Writer of element content including it's attributes.
  - text
```
public ContentWriter text(String content)
```
    Description copied from interface: ContentWriter
    
    Write text content of the currently opened tag.
    
    Specified by:
    
    text in interface ContentWriter
    
    Parameters:
    
    content - Text content to be written.
    
    Returns:
    
    Writer to continue writing additional content.
  - cdata
```
public ContentWriter cdata(String content)
```
    Description copied from interface: ContentWriter
    
    Write CDATA content of the currently opened tag.
    
    Specified by:
    
    cdata in interface ContentWriter
    
    Parameters:
    
    content - CDATA content to be written.
    
    Returns:
    
    Writer to continue writing additional content.
  - comment
```
public ContentWriter comment(String comment)
```
    Description copied from interface: ContentWriter
    
    Write XML comment into current position.
    
    Specified by:
    
    comment in interface ContentWriter
    
    Parameters:
    
    comment - Content of the comment. Only escape invalid characters.
    
    Returns:
    
    Writer to continue writing additional content.
  - end
```
public ContentWriter end()
```
    Description copied from interface: ContentWriter
    
    End currently opened tag.
    
    Specified by:
    
    end in interface ContentWriter
    
    Returns:
    
    Parent content writer.
  - close
```
public void close()
```
    Description copied from interface: ContentWriter
    
    Close the XML document. 1. Close all opened tags 2. Close underlying output stream.
    
    Specified by:
    
    close in interface ContentWriter
  - get
```
public ContentWriter get()
```
    Specified by:
    
    get in interface Supplier<ContentWriter>

Class DocumentWriterImpl

Nested Class Summary

Nested classes/interfaces inherited from interface foundation.fluent.api.xml.DocumentWriter

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface foundation.fluent.api.xml.DocumentWriter

Method Detail

documentBuilder

version

doctype

publicDtd

systemDtd

flush

encoding

instruction

tag

tag

text

cdata

comment

end

close

get