Package com.dd.plist

Class XMLPropertyListParser

java.lang.Object

com.dd.plist.XMLPropertyListParser

public class XMLPropertyListParser
extends Object

Parses XML property lists.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	XMLPropertyListParser.PlistDtdResolver	Offline resolver for Apple's PLIST DTDs.

Field Summary

Fields

Modifier and Type	Field	Description
private static final DocumentBuilderFactory	FACTORY

Constructor Summary

Constructors

Constructor	Description
XMLPropertyListParser()

Method Summary

Modifier and Type	Method	Description
private static List<Node>	filterElementNodes(NodeList list)	Returns all element nodes that are contained in a list of nodes.
static DocumentBuilder	getDocBuilder()	Gets a DocumentBuilder to parse an XML property list.
private static String	getNodeTextContents(Node n)	Returns a node's text content.
static NSObject	parse(byte[] bytes)	Parses an XML property list from a byte array.
static NSObject	parse(File f)	Parses an XML property list file.
static NSObject	parse(InputStream is)	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(Path path)	Parses an XML property list file.
static NSObject	parse(Document doc)	Parses a property list from an XML document.
private static NSObject	parseObject(Node n)	Parses a node in the XML structure and returns the corresponding NSObject

Methods inherited from class java.lang.Object

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

Field Details

FACTORY

private static final DocumentBuilderFactory FACTORY

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,
ParseException

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 parse error occurs.

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

ParseException - If a number or date string could not be parsed.

See Also:

• DocumentBuilder.parse(java.io.File)

parse

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

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 parse error occurs.

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

ParseException - If a number or date string could not be parsed.

See Also:

• DocumentBuilder.parse(java.io.File)

parse

public static NSObject parse(byte[] bytes)
                      throws ParserConfigurationException,
ParseException,
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 parse error occurs.

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

ParseException - If a number or date string could not be parsed.

parse

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

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 parse error occurs.

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

ParseException - If a number or date string could not be parsed.

See Also:

• DocumentBuilder.parse(java.io.InputStream)

parse

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

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 parse error occurs.

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

ParseException - If a number or date string could not be parsed.

See Also:

• DocumentBuilder.parse(java.io.InputStream)

parse

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

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.

ParseException - If a number or date string could not be parsed.

parseObject

private static NSObject parseObject(Node n)
                             throws ParseException,
IOException

Parses a node in the XML structure and returns the corresponding NSObject

Parameters:

n - The XML node.

Returns:

The corresponding NSObject.

Throws:

IOException - If any I/O error occurs while parsing a Base64 encoded NSData object.

ParseException - If a number or date string could not be parsed.

filterElementNodes

private static List<Node> filterElementNodes(NodeList list)

Returns all element nodes that are contained in a list of nodes.

Parameters:

list - The list of nodes to search.

Returns:

The sub-list containing only nodes representing actual elements.

getNodeTextContents

private static String getNodeTextContents(Node n)

Returns a node's text content. This method will return the text value represented by the node's direct children. If the given node is a TEXT or CDATA node, then its value is returned.

Parameters:

n - The node.

Returns:

The node's text content.