net.sf.plist.io

Class PropertyListWriter

java.lang.Object

net.sf.plist.io.PropertyListWriter

Direct Known Subclasses:

BinaryWriter, DOMXMLWriter

public abstract class PropertyListWriter
extends java.lang.Object

Serializes a tree consisting of NSObjects to a property list.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertyListWriter.Format Consists of possible output formats

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyListWriter.Format	defaultFormat The default format used when write(NSObject, File) is called.
protected NSObject	root The root object of the tree

Constructor Summary

Constructors

Constructor and Description
PropertyListWriter(NSObject root) Construct a new PropertyListWriter

Method Summary

Methods

Modifier and Type	Method and Description
static void	write(NSObject root, java.io.File file) Convert a tree to a property list and write it to a stream
static void	write(NSObject root, java.io.File file, PropertyListWriter.Format format) Convert a tree to a property list and write it to a file
static void	write(NSObject root, java.io.OutputStream stream, PropertyListWriter.Format format) Convert a tree to a property list and write it to a stream
abstract void	write(java.io.OutputStream stream) Write the property list to a stream

Methods inherited from class java.lang.Object

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

Field Detail

defaultFormat

public static PropertyListWriter.Format defaultFormat

The default format used when write(NSObject, File) is called. This usually is PropertyListWriter.Format.BINARY on Mac OS X or PropertyListWriter.Format.XML on other operating systems, but might differ since this field is not final. If you need a specific format you should not rely on the contents of this field to stay the same. Instead you should specify the format as an argument in the write(NSObject, File, Format) method. If you do not need a specific format then it is safe to use the write(OutputStream) method without PropertyListWriter.Format argument.

root

protected final NSObject root

The root object of the tree

Constructor Detail

PropertyListWriter

public PropertyListWriter(NSObject root)

Construct a new PropertyListWriter

Parameters:

root - the root of the tree

Method Detail

write

public abstract void write(java.io.OutputStream stream)
                    throws PropertyListException,
                           java.io.IOException

Write the property list to a stream

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

write

public static void write(NSObject root,
         java.io.OutputStream stream,
         PropertyListWriter.Format format)
                  throws PropertyListException,
                         java.io.IOException

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

Parameters:

root - the root of the tree

stream - the stream to write the property list to

format - the format to use when writing

Throws:

PropertyListException - when generating the property list fails

ParserConfigurationException - when unable to create an XML document

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

write

public static void write(NSObject root,
         java.io.File file)
                  throws PropertyListException,
                         java.io.IOException

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

Throws:

PropertyListException

java.io.IOException

See Also:

write(NSObject, OutputStream, Format)

write

public static void write(NSObject root,
         java.io.File file,
         PropertyListWriter.Format format)
                  throws PropertyListException,
                         java.io.IOException

Convert a tree to a property list and write it to a file

Parameters:

root - the root of the tree

file - the file to write to

format - the format to use when writing

Throws:

PropertyListException - when generating the property list fails

ParserConfigurationException - when unable to create an XML document

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