Class PropertyListParser

java.lang.Object

com.dd.plist.PropertyListParser

public class PropertyListParser
extends Object

Parses property lists. The parser can handle files, input streams and byte arrays. All known property list formats are supported.

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	READ_BUFFER_LENGTH
private static final int	TYPE_ASCII
private static final int	TYPE_BINARY
private static final int	TYPE_ERROR_BLANK
private static final int	TYPE_ERROR_UNKNOWN
private static final int	TYPE_XML

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PropertyListParser()	Prevent instantiation.

Method Summary

Modifier and Type	Method	Description
static void	convertToASCII(File in, File out)	Deprecated. Use PropertyListConverter instead.
static void	convertToBinary(File in, File out)	Deprecated. Use PropertyListConverter instead.
static void	convertToGnuStepASCII(File in, File out)	Deprecated. Use PropertyListConverter instead.
static void	convertToXml(File in, File out)	Deprecated. Use PropertyListConverter instead.
private static int	determineType(InputStream is, int offset)	Determines the property list type by means of the first bytes of its data.
private static int	determineType(String dataBeginning)	Determines the property list type by means of the first bytes of its data.
static NSObject	parse(byte[] bytes)	Parses a property list from a byte array.
static NSObject	parse(File f)	Parses a property list from a file.
static NSObject	parse(InputStream is)	Parses a property list from an InputStream.
static NSObject	parse(String filePath)	Parses a property list from a file.
static NSObject	parse(Path path)	Parses a property list from a file.
protected static byte[]	readAll(InputStream in)	Reads all bytes from an InputStream and stores them in an array, up to a maximum count.
static void	saveAsASCII(NSArray root, File out)	Deprecated. Use ASCIIPropertyListWriter instead.
static void	saveAsASCII(NSDictionary root, File out)	Deprecated. Use ASCIIPropertyListWriter instead.
static void	saveAsBinary(NSObject root, File out)	Deprecated. Use BinaryPropertyListWriter instead.
static void	saveAsBinary(NSObject root, OutputStream out)	Deprecated. Use BinaryPropertyListWriter instead.
static void	saveAsGnuStepASCII(NSArray root, File out)	Deprecated. Use ASCIIPropertyListWriter instead.
static void	saveAsGnuStepASCII(NSDictionary root, File out)	Deprecated. Use ASCIIPropertyListWriter instead.
static void	saveAsXML(NSObject root, File out)	Deprecated. Use XMLPropertyListWriter instead.
static void	saveAsXML(NSObject root, OutputStream out)	Deprecated. Use XMLPropertyListWriter instead.

Methods inherited from class Object

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

Field Details

TYPE_XML

private static final int TYPE_XML

See Also:

• Constant Field Values

TYPE_BINARY

private static final int TYPE_BINARY

See Also:

• Constant Field Values

TYPE_ASCII

private static final int TYPE_ASCII

See Also:

• Constant Field Values

TYPE_ERROR_BLANK

private static final int TYPE_ERROR_BLANK

See Also:

• Constant Field Values

TYPE_ERROR_UNKNOWN

private static final int TYPE_ERROR_UNKNOWN

See Also:

• Constant Field Values

READ_BUFFER_LENGTH

private static final int READ_BUFFER_LENGTH

See Also:

• Constant Field Values

Constructor Details

PropertyListParser

protected PropertyListParser()

Prevent instantiation.

Method Details

determineType

private static int determineType(String dataBeginning)

Determines the property list type by means of the first bytes of its data.

Parameters:

dataBeginning - The very first bytes of data of the property list (minus any whitespace) as a string.

Returns:

The type of the property list.

determineType

private static int determineType(InputStream is,
 int offset)
                          throws IOException

Determines the property list type by means of the first bytes of its data.

Parameters:

is - An input stream pointing to the beginning of the property list data. If the stream supports marking it will be reset to the beginning of the property list data after the type has been determined.

offset - The number of bytes to skip in the stream.

Returns:

The type of the property list.

Throws:

IOException

readAll

protected static byte[] readAll(InputStream in)
                         throws IOException

Reads all bytes from an InputStream and stores them in an array, up to a maximum count.

Parameters:

in - The InputStream pointing to the data that should be stored in the array.

Returns:

An array containing all bytes that were read from the input stream.

Throws:

IOException - If an I/O error occurs while reading from the input stream.

parse

public static NSObject parse(String filePath)
                      throws ParserConfigurationException,
ParseException,
SAXException,
PropertyListFormatException,
IOException

Parses a property list from a file.

Parameters:

filePath - The path to the property list file.

Returns:

The root object in 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 the given property list has an invalid format.

parse

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

Parses a property list from a file.

Parameters:

f - The property list file.

Returns:

The root object in 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 the given property list has an invalid format.

parse

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

Parses a property list from a file.

Parameters:

path - The path to the property list file.

Returns:

The root object in 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 the given property list has an invalid format.

parse

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

Parses a property list from a byte array.

Parameters:

bytes - The property list data as a byte array.

Returns:

The root object in 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 byte array.

SAXException - If any parse error occurs.

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

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

parse

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

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

Parameters:

is - The InputStream delivering the property list 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 input stream.

SAXException - If any parse error occurs.

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

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

saveAsXML

@Deprecated
public static void saveAsXML(NSObject root,
 File out)
                      throws IOException

Deprecated.

Use XMLPropertyListWriter instead.

Saves a property list with the given object as root into an XML file.

Parameters:

root - The root object.

out - The output file. If the output file's parent directory does not exist, it will be created.

Throws:

IOException - If an error occurs during the writing process.

saveAsXML

@Deprecated
public static void saveAsXML(NSObject root,
 OutputStream out)
                      throws IOException

Deprecated.

Use XMLPropertyListWriter instead.

Saves a property list with the given object as root in XML format into an output stream. This method does not close the specified output stream.

Parameters:

root - The root object.

out - The output stream.

Throws:

IOException - If an error occurs during the writing process.

convertToXml

@Deprecated
public static void convertToXml(File in,
 File out)
                         throws ParserConfigurationException,
ParseException,
SAXException,
PropertyListFormatException,
IOException

Deprecated.

Use PropertyListConverter instead.

Converts a given property list file into the OS X and iOS XML format.

Parameters:

in - The source file.

out - The target file. If the output file's parent directory does not exist, it will be created.

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 input file or writing the output file.

SAXException - If any parse error occurs.

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

ParseException - If a date string could not be parsed.

saveAsBinary

public static void saveAsBinary(NSObject root,
 File out)
                         throws IOException

Deprecated.

Use BinaryPropertyListWriter instead.

Saves a property list with the given object as root into a binary file.

Parameters:

root - The root object.

out - The output file. If the output file's parent directory does not exist, it will be created.

Throws:

IOException - If an error occurs during the writing process.

saveAsBinary

@Deprecated
public static void saveAsBinary(NSObject root,
 OutputStream out)
                         throws IOException

Deprecated.

Use BinaryPropertyListWriter instead.

Saves a property list with the given object as root in binary format into an output stream. This method does not close the specified input stream.

Parameters:

root - The root object.

out - The output stream.

Throws:

IOException - If an error occurs during the writing process.

convertToBinary

@Deprecated
public static void convertToBinary(File in,
 File out)
                            throws IOException,
ParserConfigurationException,
ParseException,
SAXException,
PropertyListFormatException

Deprecated.

Use PropertyListConverter instead.

Converts a given property list file into the OS X and iOS binary format.

Parameters:

in - The source file.

out - The target file. If the output file's parent directory does not exist, it will be created.

Throws:

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

IOException - If any I/O error occurs while reading the input file or writing the output file.

SAXException - If any parse error occurs.

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

ParseException - If a date string could not be parsed.

saveAsASCII

@Deprecated
public static void saveAsASCII(NSDictionary root,
 File out)
                        throws IOException

Deprecated.

Use ASCIIPropertyListWriter instead.

Saves a property list with the given object as root into an ASCII file.

Parameters:

root - The root object.

out - The output file. If the output file's parent directory does not exist, it will be created.

Throws:

IOException - If an error occurs during the writing process.

saveAsASCII

@Deprecated
public static void saveAsASCII(NSArray root,
 File out)
                        throws IOException

Deprecated.

Use ASCIIPropertyListWriter instead.

Saves a property list with the given object as root into an ASCII file.

Parameters:

root - The root object.

out - The output file. If the output file's parent directory does not exist, it will be created.

Throws:

IOException - If an error occurs during the writing process.

convertToASCII

@Deprecated
public static void convertToASCII(File in,
 File out)
                           throws ParserConfigurationException,
ParseException,
SAXException,
PropertyListFormatException,
IOException

Deprecated.

Use PropertyListConverter instead.

Converts a given property list file into ASCII format.

Parameters:

in - The source file.

out - The target file. If the file's parent directory does not exist, it will be created.

Throws:

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

IOException - If any I/O error occurs while reading the input file or writing the output file.

SAXException - If any parse error occurs.

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

ParseException - If a date string could not be parsed.

saveAsGnuStepASCII

@Deprecated
public static void saveAsGnuStepASCII(NSDictionary root,
 File out)
                               throws IOException

Deprecated.

Use ASCIIPropertyListWriter instead.

Saves a property list with the given object as root into an ASCII file.

Parameters:

root - The root object.

out - The output file. If the output file's parent directory does not exist, it will be created.

Throws:

IOException - If an error occurs during the writing process.

saveAsGnuStepASCII

@Deprecated
public static void saveAsGnuStepASCII(NSArray root,
 File out)
                               throws IOException

Deprecated.

Use ASCIIPropertyListWriter instead.

Saves a property list with the given object as root into an ASCII file.

Parameters:

root - The root object.

out - The output file. If the output file's parent directory does not exist, it will be created.

Throws:

IOException - If an error occurs during the writing process.

convertToGnuStepASCII

@Deprecated
public static void convertToGnuStepASCII(File in,
 File out)
                                  throws ParserConfigurationException,
ParseException,
SAXException,
PropertyListFormatException,
IOException

Deprecated.

Use PropertyListConverter instead.

Converts a given property list file into ASCII format.

Parameters:

in - The source file.

out - The target file.

Throws:

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

IOException - If any I/O error occurs while reading the input file or writing the output file.

SAXException - If any parse error occurs.

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

ParseException - If a date string could not be parsed.