Class DomDriver

java.lang.Object

com.thoughtworks.xstream.io.AbstractDriver

com.thoughtworks.xstream.io.xml.AbstractXmlDriver

com.thoughtworks.xstream.io.xml.DomDriver

All Implemented Interfaces:

HierarchicalStreamDriver

public class DomDriver
extends AbstractXmlDriver

Field Summary

Fields

Modifier and Type	Field	Description
private DocumentBuilderFactory	documentBuilderFactory
private final String	encoding

Constructor Summary

Constructors

Constructor	Description
DomDriver()	Construct a DomDriver.
DomDriver(String encoding)	Construct a DomDriver with a specified encoding.
DomDriver(String encoding, NameCoder nameCoder)
DomDriver(String encoding, XmlFriendlyReplacer replacer)	Deprecated. As of 1.4, use DomDriver(String, NameCoder) instead.

Method Summary

Modifier and Type	Method	Description
protected DocumentBuilderFactory	createDocumentBuilderFactory()	Create the DocumentBuilderFactory instance.
HierarchicalStreamReader	createReader(File in)	Create the HierarchicalStreamReader with the stream parser reading from a File.
HierarchicalStreamReader	createReader(InputStream in)	Create the HierarchicalStreamReader with the stream parser reading from the input stream.
HierarchicalStreamReader	createReader(Reader in)	Create the HierarchicalStreamReader with the stream parser reading from the IO reader.
HierarchicalStreamReader	createReader(URL in)	Create the HierarchicalStreamReader with the stream parser reading from a URL.
private HierarchicalStreamReader	createReader(InputSource source)
HierarchicalStreamWriter	createWriter(OutputStream out)	Create the HierarchicalStreamWriter with the formatted writer.
HierarchicalStreamWriter	createWriter(Writer out)	Create the HierarchicalStreamWriter with the formatted writer.

Methods inherited from class AbstractXmlDriver

xmlFriendlyReplacer

Methods inherited from class AbstractDriver

getNameCoder

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

encoding

private final String encoding

documentBuilderFactory

private DocumentBuilderFactory documentBuilderFactory

Constructor Details

DomDriver

public DomDriver()

Construct a DomDriver.

DomDriver

public DomDriver(String encoding)

Construct a DomDriver with a specified encoding. The created DomReader will ignore any encoding attribute of the XML header though.

DomDriver

public DomDriver(String encoding,
 NameCoder nameCoder)

Since:

1.4

DomDriver

public DomDriver(String encoding,
 XmlFriendlyReplacer replacer)

Deprecated.

As of 1.4, use DomDriver(String, NameCoder) instead.

Since:

1.2

Method Details

createReader

public HierarchicalStreamReader createReader(Reader in)

Description copied from interface: HierarchicalStreamDriver

Create the HierarchicalStreamReader with the stream parser reading from the IO reader.

Parameters:

in - the Reader with the data to parse

Returns:

the HierarchicalStreamReader

createReader

public HierarchicalStreamReader createReader(InputStream in)

Description copied from interface: HierarchicalStreamDriver

Create the HierarchicalStreamReader with the stream parser reading from the input stream.

Parameters:

in - the InputStream with the data to parse

createReader

public HierarchicalStreamReader createReader(URL in)

Description copied from class: AbstractDriver

Create the HierarchicalStreamReader with the stream parser reading from a URL. Depending on the parser implementation, some might take the URL as SystemId to resolve additional references.

Specified by:

createReader in interface HierarchicalStreamDriver

Overrides:

createReader in class AbstractDriver

Parameters:

in - the URL defining the location with the data to parse

Returns:

the HierarchicalStreamReader

createReader

public HierarchicalStreamReader createReader(File in)

Description copied from class: AbstractDriver

Create the HierarchicalStreamReader with the stream parser reading from a File. Depending on the parser implementation, some might take the file path as SystemId to resolve additional references.

Specified by:

createReader in interface HierarchicalStreamDriver

Overrides:

createReader in class AbstractDriver

Parameters:

in - the URL defining the location with the data to parse

Returns:

the HierarchicalStreamReader

createReader

private HierarchicalStreamReader createReader(InputSource source)

createWriter

public HierarchicalStreamWriter createWriter(Writer out)

Description copied from interface: HierarchicalStreamDriver

Create the HierarchicalStreamWriter with the formatted writer.

Parameters:

out - the Writer to receive the formatted data

Returns:

the HierarchicalStreamWriter

createWriter

public HierarchicalStreamWriter createWriter(OutputStream out)

Description copied from interface: HierarchicalStreamDriver

Create the HierarchicalStreamWriter with the formatted writer.

Parameters:

out - the OutputStream to receive the formatted data

Returns:

the HierarchicalStreamWriter

createDocumentBuilderFactory

protected DocumentBuilderFactory createDocumentBuilderFactory()

Create the DocumentBuilderFactory instance.

Returns:

the new instance

Since:

1.4.9