net.sf.plist.io

Class PropertyListParser

java.lang.Object

net.sf.plist.io.PropertyListParser

Direct Known Subclasses:

BinaryParser, DOMXMLParser

public abstract class PropertyListParser
extends java.lang.Object

Parses a property list to a tree consisting of NSObjects

Constructor Summary

Constructors

Constructor and Description
PropertyListParser(java.io.InputStream input) Construct a new PropertyListParser which will parse a InputStream

Method Summary

Methods

Modifier and Type	Method and Description
static PropertyListFormat	getFormatForFile(java.io.File file) Get the format for a Property List file.
static PropertyListFormat	getFormatForFile(java.io.File file, boolean cacheOnly) Get the format for a Property List file.
abstract NSObject	parse() Parse the Property List input (provided in the constructor) to a tree of NSObjects
static NSObject	parse(java.io.File file) Parse a Property List file.
static NSObject	parse(java.io.InputStream input) Parse a Property List InputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyListParser

public PropertyListParser(java.io.InputStream input)

Construct a new PropertyListParser which will parse a InputStream

Parameters:

input - the InputStream to parse

Method Detail

parse

public abstract NSObject parse()
                        throws PropertyListException

Parse the Property List input (provided in the constructor) to a tree of NSObjects

Returns:

the root NSObject of the parsed Property List

Throws:

PropertyListException - when parsing the Property List failed

getFormatForFile

public static PropertyListFormat getFormatForFile(java.io.File file)

Get the format for a Property List file. If the file has not been read before, it will be read to determine the format.

Parameters:

file - The file which format must be determined.

Returns:

The type of file, or null if the type could not be determined for any reason

getFormatForFile

public static PropertyListFormat getFormatForFile(java.io.File file,
                                  boolean cacheOnly)

Get the format for a Property List file. This implementation is capable of returning null if the file has not been read yet, opposed to reading the file and returning the type.

Parameters:

file - The file which format must be determined.

cacheOnly - Do not find out which format a file has if it is not in the cache yet but return null instead.

Returns:

The type of file, or null if the type could not be determined for any reason

parse

public static NSObject parse(java.io.File file)
                      throws PropertyListException,
                             java.io.IOException

Parse a Property List file.

Parameters:

file - the file to parse

Returns:

the root NSObject of the parsed Property List

Throws:

PropertyListException - when parsing the file failed

java.io.IOException - when reading the file failed

parse

public static NSObject parse(java.io.InputStream input)
                      throws PropertyListException,
                             java.io.IOException

Parse a Property List InputStream.

It is recommended to use an implementation where InputStream.markSupported() returns true.
InputStreams not meeting this recommendation will be wrapped inside a BufferedInputStream, which does.
Mark is required to make it possible to try multiple parsing methods without consuming the InputStream.

Warning: This method will not explicitly close the InputStream. You will have to close the stream yourself by calling InputStream.close() after parse(InputStream).

Parameters:

input - the InputStream to parse (instance with mark support recommended)

Returns:

the root NSObject of the parsed property list

Throws:

PropertyListException - when parsing the input failed

java.io.IOException - when reading the input failed