net.sf.plist.io.domxml

Class DOMXMLWriter

java.lang.Object

net.sf.plist.io.PropertyListWriter

net.sf.plist.io.domxml.DOMXMLWriter

public class DOMXMLWriter
extends PropertyListWriter

Serializes a tree consisting of NSObjects to an XML property list

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.plist.io.PropertyListWriter

PropertyListWriter.Format

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.xml.parsers.DocumentBuilder	db The DocumentBuilder
protected static javax.xml.parsers.DocumentBuilderFactory	dbf The DocumentBuilderFactory
protected org.w3c.dom.Document	doc The XML document
static java.lang.String	DOCTYPE_PUBLIC The public declaration of the document type
static java.lang.String	DOCTYPE_SYSTEM The URL of the document type
static java.lang.String	VERSION Version of this XML format

Fields inherited from class net.sf.plist.io.PropertyListWriter

defaultFormat, root

Constructor Summary

Constructors

Constructor and Description
DOMXMLWriter(NSObject root)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.w3c.dom.Element	generateArray(NSArray array) Convert an NSArray to an XML element
protected org.w3c.dom.Element	generateBoolean(NSBoolean bool) Convert an NSBoolean to an XML element
protected org.w3c.dom.Element	generateData(NSData data) Convert an NSData to an XML element
protected org.w3c.dom.Element	generateDate(NSDate date) Convert an NSDate to an XML element
protected org.w3c.dom.Element	generateDictionary(NSDictionary dictionary) Convert an NSDictionary to an XML element
protected org.w3c.dom.Element	generateInteger(NSInteger integer) Convert an NSInteger to an XML element
protected org.w3c.dom.Element	generateKey(java.lang.String name) Creates a key XML element
protected org.w3c.dom.Element	generateNode(NSObject obj) Convert an NSObject to an XML element
protected org.w3c.dom.Element	generateReal(NSReal real) Convert an NSReal to an XML element
protected org.w3c.dom.Element	generateString(NSString string) Convert an NSString to an XML element
void	write(java.io.OutputStream stream) Write the property list to a stream
void	write(java.io.OutputStream stream, boolean indent) Convert a tree to a XML property list and write it to a stream

Methods inherited from class net.sf.plist.io.PropertyListWriter

write, write, write

Methods inherited from class java.lang.Object

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

Field Detail

doc

protected final org.w3c.dom.Document doc

The XML document

dbf

protected static final javax.xml.parsers.DocumentBuilderFactory dbf

The DocumentBuilderFactory

db

protected final javax.xml.parsers.DocumentBuilder db

The DocumentBuilder

DOCTYPE_PUBLIC

public static final java.lang.String DOCTYPE_PUBLIC

The public declaration of the document type

See Also:

Constant Field Values

DOCTYPE_SYSTEM

public static final java.lang.String DOCTYPE_SYSTEM

The URL of the document type

See Also:

Constant Field Values

VERSION

public static final java.lang.String VERSION

Version of this XML format

See Also:

Constant Field Values

Constructor Detail

DOMXMLWriter

public DOMXMLWriter(NSObject root)

See Also:

PropertyListWriter.PropertyListWriter(NSObject)

Method Detail

write

public void write(java.io.OutputStream stream)
           throws org.w3c.dom.DOMException,
                  PropertyListException,
                  java.io.IOException

Write the property list to a stream

Specified by:

write in class PropertyListWriter

Parameters:

stream - the stream to write the property list to

Throws:

PropertyListException - when generating the property list fails

java.io.IOException - when writing to the stream fails

org.w3c.dom.DOMException

write

public void write(java.io.OutputStream stream,
         boolean indent)
           throws org.w3c.dom.DOMException,
                  PropertyListException,
                  java.io.IOException

Convert a tree to a XML property list and write it to a stream

Parameters:

stream - the stream to write the property list to

indent - whether the resulting XML file should be indented

Throws:

org.w3c.dom.DOMException - when an error occurred generating the XML document

PropertyListException - when generating the property list fails

java.io.IOException - if an I/O error occurs

generateNode

protected org.w3c.dom.Element generateNode(NSObject obj)
                                    throws PropertyListException

Convert an NSObject to an XML element

Parameters:

obj - the NSObject to convert

Returns:

the XML element

Throws:

PropertyListException - when generating the property list fails

generateArray

protected org.w3c.dom.Element generateArray(NSArray array)
                                     throws org.w3c.dom.DOMException,
                                            PropertyListException

Convert an NSArray to an XML element

Parameters:

array - the NSArray to convert

Returns:

the XML element

Throws:

PropertyListException - when generating the property list fails

org.w3c.dom.DOMException

generateBoolean

protected org.w3c.dom.Element generateBoolean(NSBoolean bool)

Convert an NSBoolean to an XML element

Parameters:

bool - the NSBoolean to convert

Returns:

the XML element

Throws:

PropertyListException - when generating the property list fails

generateData

protected org.w3c.dom.Element generateData(NSData data)

Convert an NSData to an XML element

Parameters:

data - the NSData to convert

Returns:

the XML element

Throws:

PropertyListException - when generating the property list fails

generateDate

protected org.w3c.dom.Element generateDate(NSDate date)

Convert an NSDate to an XML element

Parameters:

date - the NSDate to convert

Returns:

the XML element

Throws:

PropertyListException - when generating the property list fails

generateDictionary

protected org.w3c.dom.Element generateDictionary(NSDictionary dictionary)
                                          throws org.w3c.dom.DOMException,
                                                 PropertyListException

Convert an NSDictionary to an XML element

Parameters:

dictionary - the NSDictionary to convert

Returns:

the XML element

Throws:

PropertyListException - when generating the property list fails

org.w3c.dom.DOMException

generateReal

protected org.w3c.dom.Element generateReal(NSReal real)

Convert an NSReal to an XML element

Parameters:

real - the NSReal to convert

Returns:

the XML element

Throws:

PropertyListException - when generating the property list fails

generateInteger

protected org.w3c.dom.Element generateInteger(NSInteger integer)

Convert an NSInteger to an XML element

Parameters:

integer - the NSInteger to convert

Returns:

the XML element

Throws:

PropertyListException - when generating the property list fails

generateString

protected org.w3c.dom.Element generateString(NSString string)

Convert an NSString to an XML element

Parameters:

string - the NSString to convert

Returns:

the XML element

Throws:

PropertyListException - when generating the property list fails

generateKey

protected org.w3c.dom.Element generateKey(java.lang.String name)

Creates a key XML element

Parameters:

name - the name of the key

Returns:

the XML element

Throws:

PropertyListException - when generating the property list fails