XmlWriter (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.graphml.XmlWriter

All Implemented Interfaces:

IXmlWriter
```
public class XmlWriter
extends Object
implements IXmlWriter
```
Implementation of IXmlWriter that writes directly to an output stream.
This writer does not support random access on the output document.

Constructor Summary

Constructors
Constructor and Description
`XmlWriter(OutputStream os, Charset enc)` Create a new instance that writes on the given stream with a specified encoding.
`XmlWriter(OutputStream os, Charset enc, boolean indent)` Create a new instance that writes on the given stream with a specified encoding.
`XmlWriter(Writer os)` Create a new instance that writes on a `Writer`.
`XmlWriter(Writer os, boolean indent)` Create a new instance that writes on a `Writer`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected IXmlNamespaceManager`	`createNamespaceManager()` Factory method that creates the namespace manager for this instance.
`void`	`flushDocument()` Close the document.
`IXmlNamespaceManager`	`getNamespaceManager()` Gets the namespace manager associated with this writer.
`IXmlWriter`	`writeAttribute(String prefix, String localName, String ns, String value)` Write a XML attribute node.
`IXmlWriter`	`writeCData(String content)` Write a CDATA section.
`IXmlWriter`	`writeComment(String comment)` Write a XML comment node.
`IXmlWriter`	`writeDocumentFragment(Document fragment)` Write a document fragment.
`void`	`writeEndDocument()` Close the output.
`IXmlWriter`	`writeEndElement()` Close a XML element previously opened with `IXmlWriter.writeStartElement(String, String)` or `IXmlWriter.writeStartElement(String, String, String)`.
`IXmlWriter`	`writeProcessingInstruction(String target, String data)` Write a xml processing instruction.
`IXmlWriter`	`writeStartDocument()` Begin the output process.
`IXmlWriter`	`writeStartElement(String localName, String ns)` Begin a new XML element with given parameters.
`IXmlWriter`	`writeStartElement(String prefix, String s, String ns)` Begin a new XML element with given parameters.
`IXmlWriter`	`writeString(String s)` Write a text node.

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

Methods inherited from interface com.yworks.yfiles.graphml.IXmlWriter
writeAttribute, writeAttribute

- Constructor Detail
  - XmlWriter
```
public XmlWriter(OutputStream os,
                 Charset enc)
```
    Create a new instance that writes on the given stream with a specified encoding.
    
    Parameters:
    
    os - The output stream
    
    enc - The document encoding
  - XmlWriter
```
public XmlWriter(OutputStream os,
                 Charset enc,
                 boolean indent)
```
    Create a new instance that writes on the given stream with a specified encoding.
    
    Parameters:
    
    os - The output stream
    
    enc - The document encoding
    
    indent - Whether the output should be indented or not. Default is true
  - XmlWriter
```
public XmlWriter(Writer os)
```
    Create a new instance that writes on a Writer.
    The document encoding is fixed by the os encoding
    
    Parameters:
    
    os - The output stream
  - XmlWriter
```
public XmlWriter(Writer os,
                 boolean indent)
```
    Create a new instance that writes on a Writer.
    The document encoding is fixed by the os encoding
    
    Parameters:
    
    os - The output stream
    
    indent - Whether the output should be indented or not. Default is true
- Method Detail
  - createNamespaceManager
```
protected IXmlNamespaceManager createNamespaceManager()
```
    Factory method that creates the namespace manager for this instance.
    
    Returns:
    
    A new manager instance.
  - flushDocument
```
public void flushDocument()
```
    Description copied from interface: IXmlWriter
    
    Close the document.
    This is typically used to actually flush the document to an output stream
    
    Specified by:
    
    flushDocument in interface IXmlWriter
  - getNamespaceManager
```
public final IXmlNamespaceManager getNamespaceManager()
```
    Gets the namespace manager associated with this writer.
    
    Specified by:
    
    getNamespaceManager in interface IXmlWriter
    
    Returns:
    
    The namespace manager.
  - writeAttribute
```
public IXmlWriter writeAttribute(String prefix,
                                 String localName,
                                 String ns,
                                 String value)
```
    Description copied from interface: IXmlWriter
    
    Write a XML attribute node.
    The attribute is attached to the closest open XML element that has been started with IXmlWriter.writeStartElement(String, String) or IXmlWriter.writeStartElement(String, String, String)
    
    Specified by:
    
    writeAttribute in interface IXmlWriter
    
    Parameters:
    
    prefix - The namespace prefix of the attribute
    
    localName - The local name of the attribute
    
    ns - The namespace URI of this attribute
    
    value - The value of this attribute
    
    Returns:
    
    The writer instance for further chaining
  - writeCData
```
public IXmlWriter writeCData(String content)
```
    Description copied from interface: IXmlWriter
    
    Write a CDATA section.
    
    Specified by:
    
    writeCData in interface IXmlWriter
    
    Parameters:
    
    content - The content of the CDATA section
    
    Returns:
    
    The writer instance for further chaining
  - writeComment
```
public IXmlWriter writeComment(String comment)
```
    Description copied from interface: IXmlWriter
    
    Write a XML comment node.
    
    Specified by:
    
    writeComment in interface IXmlWriter
    
    Parameters:
    
    comment - The content of the comment
    
    Returns:
    
    The writer instance for further chaining
  - writeDocumentFragment
```
public IXmlWriter writeDocumentFragment(Document fragment)
```
    Description copied from interface: IXmlWriter
    
    Write a document fragment.
    
    Specified by:
    
    writeDocumentFragment in interface IXmlWriter
    
    Returns:
    
    The writer instance for further chaining
  - writeEndDocument
```
public void writeEndDocument()
```
    Description copied from interface: IXmlWriter
    
    Close the output.
    Attempts to write after this method has been called will have undefined results.
    
    Specified by:
    
    writeEndDocument in interface IXmlWriter
  - writeEndElement
```
public IXmlWriter writeEndElement()
```
    Description copied from interface: IXmlWriter
    
    Close a XML element previously opened with IXmlWriter.writeStartElement(String, String) or IXmlWriter.writeStartElement(String, String, String).
    
    Specified by:
    
    writeEndElement in interface IXmlWriter
    
    Returns:
    
    The writer instance for further chaining
  - writeProcessingInstruction
```
public IXmlWriter writeProcessingInstruction(String target,
                                             String data)
```
    Description copied from interface: IXmlWriter
    
    Write a xml processing instruction.
    
    Specified by:
    
    writeProcessingInstruction in interface IXmlWriter
    
    Parameters:
    
    target - The target of the PI
    
    data - The data of the PI
    
    Returns:
    
    The writer instance for further chaining
  - writeStartDocument
```
public IXmlWriter writeStartDocument()
```
    Description copied from interface: IXmlWriter
    
    Begin the output process.
    
    Specified by:
    
    writeStartDocument in interface IXmlWriter
    
    Returns:
    
    The writer instance for further chaining
  - writeStartElement
```
public IXmlWriter writeStartElement(String localName,
                                    String ns)
```
    Description copied from interface: IXmlWriter
    
    Begin a new XML element with given parameters.
    All subsequent output is attached to this element until IXmlWriter.writeEndElement() has been called or a new element has been started.
    
    This acts like IXmlWriter.writeStartElement(String, String, String), but uses the default prefix for the namespace
    
    Specified by:
    
    writeStartElement in interface IXmlWriter
    
    Parameters:
    
    localName - The local name of this element
    
    ns - The namespace of this element
    
    Returns:
    
    The writer instance for further chaining
  - writeStartElement
```
public IXmlWriter writeStartElement(String prefix,
                                    String s,
                                    String ns)
```
    Description copied from interface: IXmlWriter
    
    Begin a new XML element with given parameters.
    All subsequent output is attached to this element until IXmlWriter.writeEndElement() has been called or a new element has been started.
    
    Specified by:
    
    writeStartElement in interface IXmlWriter
    
    Parameters:
    
    prefix - The namespace prefix to use for this element
    
    s - The local name of this element
    
    ns - The namespace of this element
    
    Returns:
    
    The writer instance for further chaining
  - writeString
```
public IXmlWriter writeString(String s)
```
    Description copied from interface: IXmlWriter
    
    Write a text node.
    The string value of s will be correctly escaped
    
    Specified by:
    
    writeString in interface IXmlWriter
    
    Parameters:
    
    s - The string that gets written as XML text
    
    Returns:
    
    The writer instance for further chaining

Class XmlWriter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.yworks.yfiles.graphml.IXmlWriter

Constructor Detail

XmlWriter

XmlWriter

XmlWriter

XmlWriter

Method Detail

createNamespaceManager

flushDocument

getNamespaceManager

writeAttribute

writeCData

writeComment

writeDocumentFragment

writeEndDocument

writeEndElement

writeProcessingInstruction

writeStartDocument

writeStartElement

writeStartElement

writeString