PropertyListParser (dd-plist 1.8 API)

java.lang.Object
- com.dd.plist.PropertyListParser

```
public class PropertyListParser
extends Object
```
This class provides methods to parse property lists. It can handle files, input streams and byte arrays. All known property list formats are supported.
This class also provides methods to save and convert property lists.

Author:

Daniel Dreibrodt

Constructor Summary

Constructors
Modifier Constructor and Description

protected PropertyListParser()
Prevent instantiation.

Constructors
Modifier	Constructor and Description
`protected`	`PropertyListParser()` Prevent instantiation.

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`convertToASCII(File in, File out)` Converts a given property list file into ASCII format.
`static void`	`convertToBinary(File in, File out)` Converts a given property list file into the OS X and iOS binary format.
`static void`	`convertToGnuStepASCII(File in, File out)` Converts a given property list file into ASCII format.
`static void`	`convertToXml(File in, File out)` Converts a given property list file into the OS X and iOS XML format.
`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.
`protected static byte[]`	`readAll(InputStream in, int max)` Reads all bytes from an InputStream and stores them in an array, up to a maximum count.
`static void`	`saveAsASCII(NSArray root, File out)` Saves a property list with the given object as root into a ASCII file.
`static void`	`saveAsASCII(NSDictionary root, File out)` Saves a property list with the given object as root into a ASCII file.
`static void`	`saveAsBinary(NSObject root, File out)` Saves a property list with the given object as root into a binary file.
`static void`	`saveAsBinary(NSObject root, OutputStream out)` Saves a property list with the given object as root in binary format into an output stream.
`static void`	`saveAsGnuStepASCII(NSArray root, File out)` Saves a property list with the given object as root into a ASCII file.
`static void`	`saveAsGnuStepASCII(NSDictionary root, File out)` Saves a property list with the given object as root into a ASCII file.
`static void`	`saveAsXML(NSObject root, File out)` Saves a property list with the given object as root into a XML file.
`static void`	`saveAsXML(NSObject root, OutputStream out)` Saves a property list with the given object as root in XML format into an output stream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- PropertyListParser
```
protected PropertyListParser()
```
  Prevent instantiation.

Method Detail

readAll
```
protected static byte[] readAll(InputStream in,
             int max)
                         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.
max - The maximum number of bytes to read.

Throws:

IOException

parse

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

Parses a property list from a file.

Parameters:: filePath - 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:: Exception - If an error occurred while parsing.; ParserConfigurationException; ParseException; SAXException; PropertyListFormatException; IOException

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:: Exception - If an error occurred while parsing.; IOException; PropertyListFormatException; ParseException; ParserConfigurationException; SAXException

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:: Exception - If an error occurred while parsing.; IOException; PropertyListFormatException; ParseException; ParserConfigurationException; SAXException

parse

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

Parses a property list from an InputStream.

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:: Exception - If an error occurred while parsing.; IOException; PropertyListFormatException; ParseException; ParserConfigurationException; SAXException

saveAsXML
```
public static void saveAsXML(NSObject root,
             File out)
                      throws IOException
```
Saves a property list with the given object as root into a XML file.

Parameters:
root - The root object.
out - The output file.

Throws:

IOException - When an error occurs during the writing process.

saveAsXML
```
public static void saveAsXML(NSObject root,
             OutputStream out)
                      throws IOException
```
Saves a property list with the given object as root in XML format into an output stream.

Parameters:
root - The root object.
out - The output stream.

Throws:

IOException - When an error occurs during the writing process.

convertToXml

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

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

Parameters:: in - The source file.; out - The target file.
Throws:: Exception - When an error occurs during parsing or converting.; ParserConfigurationException; ParseException; SAXException; PropertyListFormatException; IOException

saveAsBinary
```
public static void saveAsBinary(NSObject root,
                File out)
                         throws IOException
```
Saves a property list with the given object as root into a binary file.

Parameters:
root - The root object.
out - The output file.

Throws:

IOException - When an error occurs during the writing process.

saveAsBinary
```
public static void saveAsBinary(NSObject root,
                OutputStream out)
                         throws IOException
```
Saves a property list with the given object as root in binary format into an output stream.

Parameters:
root - The root object.
out - The output stream.

Throws:

IOException - When an error occurs during the writing process.

convertToBinary

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

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

Parameters:: in - The source file.; out - The target file.
Throws:: Exception - When an error occurs during parsing or converting.; IOException; ParserConfigurationException; ParseException; SAXException; PropertyListFormatException

saveAsASCII
```
public static void saveAsASCII(NSDictionary root,
               File out)
                        throws IOException
```
Saves a property list with the given object as root into a ASCII file.

Parameters:
root - The root object.
out - The output file.

Throws:

IOException - When an error occurs during the writing process.

saveAsASCII
```
public static void saveAsASCII(NSArray root,
               File out)
                        throws IOException
```
Saves a property list with the given object as root into a ASCII file.

Parameters:
root - The root object.
out - The output file.

Throws:

IOException - When an error occurs during the writing process.

convertToASCII

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

Converts a given property list file into ASCII format.

Parameters:: in - The source file.; out - The target file.
Throws:: Exception - When an error occurs during parsing or converting.; ParserConfigurationException; ParseException; SAXException; PropertyListFormatException; IOException

saveAsGnuStepASCII
```
public static void saveAsGnuStepASCII(NSDictionary root,
                      File out)
                               throws IOException
```
Saves a property list with the given object as root into a ASCII file.

Parameters:
root - The root object.
out - The output file.

Throws:

IOException - When an error occurs during the writing process.

saveAsGnuStepASCII
```
public static void saveAsGnuStepASCII(NSArray root,
                      File out)
                               throws IOException
```
Saves a property list with the given object as root into a ASCII file.

Parameters:
root - The root object.
out - The output file.

Throws:

IOException - When an error occurs during the writing process.

convertToGnuStepASCII

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

Converts a given property list file into ASCII format.

Parameters:: in - The source file.; out - The target file.
Throws:: Exception - When an error occurs during parsing or converting.; ParserConfigurationException; ParseException; SAXException; PropertyListFormatException; IOException

Class PropertyListParser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PropertyListParser

Method Detail

readAll

parse

parse

parse

parse

saveAsXML

saveAsXML

convertToXml

saveAsBinary

saveAsBinary

convertToBinary

saveAsASCII

saveAsASCII

convertToASCII

saveAsGnuStepASCII

saveAsGnuStepASCII

convertToGnuStepASCII