Class XMLPropertyListParser

java.lang.Object

com.dd.plist.XMLPropertyListParser

public class XMLPropertyListParser
extends Object

Parses XML property lists.

Author:

Daniel Dreibrodt

Constructor Summary

Constructors

Constructor	Description
XMLPropertyListParser()

Method Summary

Modifier and Type	Method	Description
static DocumentBuilder	getDocBuilder()	Gets a DocumentBuilder to parse an XML property list.
static NSObject	parse(byte[] bytes)	Parses an XML property list from a byte array.
static NSObject	parse(byte[] bytes, boolean withLineInformation)	Parses an XML property list from a byte array.
static NSObject	parse(File f)	Parses an XML property list file.
static NSObject	parse(File f, boolean withLineInformation)	Parses an XML property list file.
static NSObject	parse(InputStream is)	Parses an XML property list from an input stream.
static NSObject	parse(InputStream is, boolean withLineInformation)	Parses an XML property list from an input stream.
static NSObject	parse(Reader reader)	Parses an XML property list from a Reader.
static NSObject	parse(Reader reader, boolean withLineInformation)	Parses an XML property list from a Reader.
static NSObject	parse(Path path)	Parses an XML property list file.
static NSObject	parse(Path path, boolean withLineInformation)	Parses an XML property list file.
static NSObject	parse(Document doc)	Parses a property list from an XML document.

Methods inherited from class java.lang.Object

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

Constructor Details

XMLPropertyListParser

public XMLPropertyListParser()

Method Details

getDocBuilder

public static DocumentBuilder getDocBuilder()
                                     throws ParserConfigurationException

Gets a DocumentBuilder to parse an XML property list. As DocumentBuilder instance are not thread-safe a new DocumentBuilder is generated for each request.

Returns:

A new DocumentBuilder that can parse property lists without an internet connection.

Throws:

ParserConfigurationException - If a document builder for parsing a XML property list could not be created. This should not occur.

parse

public static NSObject parse(File f)
                      throws ParserConfigurationException,
IOException,
SAXException,
PropertyListFormatException

Parses an XML property list file.

Parameters:

f - The XML property list file.

Returns:

The root object of the property list. This is usually a NSDictionary but can also be a NSArray.

Throws:

ParserConfigurationException - If a document builder for parsing an XML property list could not be created. This should not occur.

IOException - If any I/O error occurs while reading the file.

SAXException - If any XML parsing error occurs.

PropertyListFormatException - If the given property list has an invalid format.

See Also:

• DocumentBuilder.parse(java.io.File)

parse

public static NSObject parse(Path path)
                      throws ParserConfigurationException,
IOException,
SAXException,
PropertyListFormatException

Parses an XML property list file.

Parameters:

path - The XML property list file path.

Returns:

The root object of the property list. This is usually a NSDictionary but can also be a NSArray.

Throws:

ParserConfigurationException - If a document builder for parsing an XML property list could not be created. This should not occur.

IOException - If any I/O error occurs while reading the file.

SAXException - If any XML parsing error occurs.

PropertyListFormatException - If the given property list has an invalid format.

See Also:

• DocumentBuilder.parse(java.io.File)

parse

public static NSObject parse(byte[] bytes)
                      throws ParserConfigurationException,
SAXException,
PropertyListFormatException,
IOException

Parses an XML property list from a byte array.

Parameters:

bytes - The byte array containing the property list's data.

Returns:

The root object of the property list. This is usually a NSDictionary but can also be a NSArray.

Throws:

ParserConfigurationException - If a document builder for parsing an XML property list could not be created. This should not occur.

IOException - If any I/O error occurs while reading the file.

SAXException - If any XML parsing error occurs.

PropertyListFormatException - If the given property list has an invalid format.

parse

public static NSObject parse(InputStream is)
                      throws ParserConfigurationException,
IOException,
SAXException,
PropertyListFormatException

Parses an XML property list from an input stream. This method does not close the specified input stream.

Parameters:

is - The input stream pointing to the property list's data.

Returns:

The root object of the property list. This is usually a NSDictionary but can also be a NSArray.

Throws:

ParserConfigurationException - If a document builder for parsing an XML property list could not be created. This should not occur.

IOException - If any I/O error occurs while reading the file.

SAXException - If any XML parsing error occurs.

PropertyListFormatException - If the given property list has an invalid format.

See Also:

• DocumentBuilder.parse(java.io.InputStream)

parse

public static NSObject parse(Reader reader)
                      throws ParserConfigurationException,
IOException,
SAXException,
PropertyListFormatException

Parses an XML property list from a Reader. This method does not close the specified reader.

Parameters:

reader - The reader providing the property list's data.

Returns:

The root object of the property list. This is usually a NSDictionary but can also be a NSArray.

Throws:

ParserConfigurationException - If a document builder for parsing an XML property list could not be created. This should not occur.

IOException - If any I/O error occurs while reading the file.

SAXException - If any XML parsing error occurs.

PropertyListFormatException - If the given property list has an invalid format.

See Also:

• DocumentBuilder.parse(java.io.InputStream)

parse

public static NSObject parse(File f,
 boolean withLineInformation)
                      throws ParserConfigurationException,
IOException,
SAXException,
PropertyListFormatException

Parses an XML property list file.

Parameters:

f - The XML property list file.

withLineInformation - If set to true, the parser will try to collect line information and store it in the parsed object's location information (See NSObject.getLocationInformation()).

Returns:

The root object of the property list. This is usually a NSDictionary but can also be a NSArray.

Throws:

ParserConfigurationException - If a document builder for parsing an XML property list could not be created. This should not occur.

IOException - If any I/O error occurs while reading the file.

SAXException - If any XML parsing error occurs.

PropertyListFormatException - If the given property list has an invalid format.

See Also:

• DocumentBuilder.parse(java.io.File)

parse

public static NSObject parse(Path path,
 boolean withLineInformation)
                      throws ParserConfigurationException,
IOException,
SAXException,
PropertyListFormatException

Parses an XML property list file.

Parameters:

path - The XML property list file path.

withLineInformation - If set to true, the parser will try to collect line information and store it in the parsed object's location information

Returns:

The root object of the property list. This is usually a NSDictionary but can also be a NSArray.

Throws:

ParserConfigurationException - If a document builder for parsing an XML property list could not be created. This should not occur.

IOException - If any I/O error occurs while reading the file.

SAXException - If any XML parsing error occurs.

PropertyListFormatException - If the given property list has an invalid format.

See Also:

• DocumentBuilder.parse(java.io.File)

parse

public static NSObject parse(byte[] bytes,
 boolean withLineInformation)
                      throws ParserConfigurationException,
SAXException,
PropertyListFormatException,
IOException

Parses an XML property list from a byte array.

Parameters:

bytes - The byte array containing the property list's data.

withLineInformation - If set to true, the parser will try to collect line information and store it in the parsed object's location information

Returns:

The root object of the property list. This is usually a NSDictionary but can also be a NSArray.

Throws:

ParserConfigurationException - If a document builder for parsing an XML property list could not be created. This should not occur.

IOException - If any I/O error occurs while reading the file.

SAXException - If any XML parsing error occurs.

PropertyListFormatException - If the given property list has an invalid format.

parse

public static NSObject parse(InputStream is,
 boolean withLineInformation)
                      throws ParserConfigurationException,
IOException,
SAXException,
PropertyListFormatException

Parses an XML property list from an input stream. This method does not close the specified input stream.

Parameters:

is - The input stream pointing to the property list's data.

withLineInformation - If set to true, the parser will try to collect line information and store it in the parsed object's location information

Returns:

The root object of the property list. This is usually a NSDictionary but can also be a NSArray.

Throws:

ParserConfigurationException - If a document builder for parsing an XML property list could not be created. This should not occur.

IOException - If any I/O error occurs while reading the file.

SAXException - If any XML parsing error occurs.

PropertyListFormatException - If the given property list has an invalid format.

See Also:

• DocumentBuilder.parse(java.io.InputStream)

parse

public static NSObject parse(Reader reader,
 boolean withLineInformation)
                      throws ParserConfigurationException,
IOException,
SAXException,
PropertyListFormatException

Parses an XML property list from a Reader. This method does not close the specified reader.

Parameters:

reader - The reader providing the property list's data.

withLineInformation - If set to true, the parser will try to collect line information and store it in the parsed object's location information

Returns:

The root object of the property list. This is usually a NSDictionary but can also be a NSArray.

Throws:

ParserConfigurationException - If a document builder for parsing an XML property list could not be created. This should not occur.

IOException - If any I/O error occurs while reading the file.

SAXException - If any XML parsing error occurs.

PropertyListFormatException - If the given property list has an invalid format.

See Also:

• DocumentBuilder.parse(java.io.InputStream)

parse

public static NSObject parse(Document doc)
                      throws PropertyListFormatException,
IOException

Parses a property list from an XML document.

Parameters:

doc - The XML document.

Returns:

The root NSObject of the property list contained in the XML document.

Throws:

IOException - If any I/O error occurs while reading the file.

PropertyListFormatException - If the given property list has an invalid format.