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

```
public final class BinaryPropertyListParser
extends java.lang.Object
```
Parses property lists that are in Apple's binary format. Use this class when you are sure about the format of the property list. Otherwise, use the PropertyListParser class.
Parsing is done by calling the static parse methods.

Field Summary

Fields
Modifier and Type	Field	Description
`private static int`	`ARRAY_TYPE`
`private static int`	`ASCII_STRING_TYPE`
`private byte[]`	`bytes`	The property list data.
`private static int`	`DATA_TYPE`
`private static int`	`DATE_TYPE`
`private static int`	`DICTIONARY_TYPE`
`private static int`	`INT_TYPE`
`private int`	`majorVersion`	Major version of the property list format
`private int`	`minorVersion`	Minor version of the property list format
`private int`	`numObjects`
`private int`	`objectRefSize`	Length of an object reference in bytes
`private int`	`offsetSize`
`private int`	`offsetTableOffset`
`private static int`	`ORDERED_SET_TYPE`
`private java.util.HashMap<java.lang.Integer,NSObject>`	`parsedObjects`
`private static int`	`REAL_TYPE`
`private static int`	`SET_TYPE`
`private static int`	`SIMPLE_TYPE`
`private static int`	`UID_TYPE`
`private static int`	`UTF16_STRING_TYPE`
`private static int`	`UTF8_STRING_TYPE`

Constructor Summary

Constructors
Modifier Constructor Description

private BinaryPropertyListParser()
Protected constructor so that instantiation is fully controlled by the static parse methods.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private int`	`calculateUtf8StringLength(int offset, int numCharacters)`
`static byte[]`	`copyOfRange(byte[] src, int startIndex, int endIndex)`	Copies a part of a byte array into a new array.
`private NSObject`	`doParse(byte[] data)`	Parses a binary property list from a byte array.
`private int`	`getObjectOffset(int obj)`
`private boolean`	`hastUtf8Sequence(int offset, int n)`
`static NSObject`	`parse(byte[] data)`	Parses a binary property list from a byte array.
`static NSObject`	`parse(java.io.File f)`	Parses a binary property list file.
`static NSObject`	`parse(java.io.InputStream is)`	Parses a binary property list from an input stream.
`static NSObject`	`parse(java.nio.file.Path path)`	Parses a binary property list file.
`private NSArray`	`parseArray(int offset, int objInfo, ParsedObjectStack stack)`
`private NSData`	`parseData(int offset, int objInfo)`
`private NSDate`	`parseDate(int offset, int objInfo)`
`private NSDictionary`	`parseDictionary(int offset, int objInfo, ParsedObjectStack stack)`
`static double`	`parseDouble(byte[] bytes)`	Parses a double from a (big-endian) byte array.
`static double`	`parseDouble(byte[] bytes, int startIndex, int endIndex)`	Parses a double from a (big-endian) byte array.
`static long`	`parseLong(byte[] bytes)`	Parses a long from a (big-endian) byte array.
`static long`	`parseLong(byte[] bytes, int startIndex, int endIndex)`	Parses a long from a (big-endian) byte array.
`private NSNumber`	`parseNumber(int offset, int objInfo, int integer)`
`private NSObject`	`parseObject(ParsedObjectStack stack, int obj)`	Parses an object inside the currently parsed binary property list.
`private int`	`parseObjectReference(int offset)`
`private int`	`parseObjectReferenceFromList(int baseOffset, int objectIndex)`
`private NSSet`	`parseSet(int offset, int objInfo, boolean ordered, ParsedObjectStack stack)`
`private NSObject`	`parseSimpleObject(int offset, int objInfo, int objType, int obj)`
`private NSString`	`parseString(int offset, int objInfo, java.util.function.BiFunction<java.lang.Integer,java.lang.Integer,java.lang.Integer> stringLengthCalculator, java.lang.String charsetName)`
`private UID`	`parseUid(int obj, int offset, int length)`
`static long`	`parseUnsignedInt(byte[] bytes)`	Parses an unsigned integers from a byte array.
`static long`	`parseUnsignedInt(byte[] bytes, int startIndex, int endIndex)`	Parses an unsigned integer from a byte array.
`private int[]`	`readLengthAndOffset(int objInfo, int offset)`

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

- Field Detail
  - SIMPLE_TYPE
```
private static final int SIMPLE_TYPE
```
    See Also:
    
    Constant Field Values
  - INT_TYPE
```
private static final int INT_TYPE
```
    See Also:
    
    Constant Field Values
  - REAL_TYPE
```
private static final int REAL_TYPE
```
    See Also:
    
    Constant Field Values
  - DATE_TYPE
```
private static final int DATE_TYPE
```
    See Also:
    
    Constant Field Values
  - DATA_TYPE
```
private static final int DATA_TYPE
```
    See Also:
    
    Constant Field Values
  - ASCII_STRING_TYPE
```
private static final int ASCII_STRING_TYPE
```
    See Also:
    
    Constant Field Values
  - UTF16_STRING_TYPE
```
private static final int UTF16_STRING_TYPE
```
    See Also:
    
    Constant Field Values
  - UTF8_STRING_TYPE
```
private static final int UTF8_STRING_TYPE
```
    See Also:
    
    Constant Field Values
  - UID_TYPE
```
private static final int UID_TYPE
```
    See Also:
    
    Constant Field Values
  - ARRAY_TYPE
```
private static final int ARRAY_TYPE
```
    See Also:
    
    Constant Field Values
  - ORDERED_SET_TYPE
```
private static final int ORDERED_SET_TYPE
```
    See Also:
    
    Constant Field Values
  - SET_TYPE
```
private static final int SET_TYPE
```
    See Also:
    
    Constant Field Values
  - DICTIONARY_TYPE
```
private static final int DICTIONARY_TYPE
```
    See Also:
    
    Constant Field Values
  - majorVersion
```
private int majorVersion
```
    Major version of the property list format
  - minorVersion
```
private int minorVersion
```
    Minor version of the property list format
  - bytes
```
private byte[] bytes
```
    The property list data.
  - objectRefSize
```
private int objectRefSize
```
    Length of an object reference in bytes
  - offsetSize
```
private int offsetSize
```
  - numObjects
```
private int numObjects
```
  - offsetTableOffset
```
private int offsetTableOffset
```
  - parsedObjects
```
private java.util.HashMap<java.lang.Integer,NSObject> parsedObjects
```
- Constructor Detail
  - BinaryPropertyListParser
```
private BinaryPropertyListParser()
```
    Protected constructor so that instantiation is fully controlled by the static parse methods.
    
    See Also:
    
    parse(byte[])
- Method Detail
  - parse
```
public static NSObject parse(java.io.File f)
                      throws java.io.IOException,
                             PropertyListFormatException
```
    Parses a binary property list file.
    
    Parameters:
    
    f - The binary property list file
    
    Returns:
    
    The root object of the property list. This is usually a NSDictionary but can also be a NSArray.
    
    Throws:
    
    PropertyListFormatException - When the property list's format could not be parsed.
    
    java.io.IOException - If a NSString object could not be decoded or an I/O error occurs on the input stream.
  - parse
```
public static NSObject parse(java.nio.file.Path path)
                      throws java.io.IOException,
                             PropertyListFormatException
```
    Parses a binary property list file.
    
    Parameters:
    
    path - The path to the binary property list file
    
    Returns:
    
    The root object of the property list. This is usually a NSDictionary but can also be a NSArray.
    
    Throws:
    
    PropertyListFormatException - When the property list's format could not be parsed.
    
    java.io.IOException - If a NSString object could not be decoded or an I/O error occurs on the input stream.
  - parse
```
public static NSObject parse(java.io.InputStream is)
                      throws java.io.IOException,
                             PropertyListFormatException
```
    Parses a binary property list from an input stream. This method does not close the specified input stream.
    
    Parameters:
    
    is - The input stream that points 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:
    
    PropertyListFormatException - When the property list's format could not be parsed.
    
    java.io.IOException - If a NSString object could not be decoded or an I/O error occurs on the input stream.
  - parse
```
public static NSObject parse(byte[] data)
                      throws PropertyListFormatException,
                             java.io.UnsupportedEncodingException
```
    Parses a binary property list from a byte array.
    
    Parameters:
    
    data - The binary property list's data.
    
    Returns:
    
    The root object of the property list. This is usually a NSDictionary but can also be a NSArray.
    
    Throws:
    
    PropertyListFormatException - When the property list's format could not be parsed.
    
    java.io.UnsupportedEncodingException - If a NSString object could not be decoded.
  - parseUnsignedInt
```
public static long parseUnsignedInt(byte[] bytes)
```
    Parses an unsigned integers from a byte array.
    
    Parameters:
    
    bytes - The byte array containing the unsigned integer.
    
    Returns:
    
    The unsigned integer represented by the given bytes.
  - parseUnsignedInt
```
public static long parseUnsignedInt(byte[] bytes,
                                    int startIndex,
                                    int endIndex)
```
    Parses an unsigned integer from a byte array.
    
    Parameters:
    
    bytes - The byte array containing the unsigned integer.
    
    startIndex - Beginning of the unsigned int in the byte array.
    
    endIndex - End of the unsigned int in the byte array.
    
    Returns:
    
    The unsigned integer represented by the given bytes.
  - parseLong
```
public static long parseLong(byte[] bytes)
```
    Parses a long from a (big-endian) byte array.
    
    Parameters:
    
    bytes - The bytes representing the long integer.
    
    Returns:
    
    The long integer represented by the given bytes.
  - parseLong
```
public static long parseLong(byte[] bytes,
                             int startIndex,
                             int endIndex)
```
    Parses a long from a (big-endian) byte array.
    
    Parameters:
    
    bytes - The bytes representing the long integer.
    
    startIndex - Beginning of the long in the byte array.
    
    endIndex - End of the long in the byte array.
    
    Returns:
    
    The long integer represented by the given bytes.
  - parseDouble
```
public static double parseDouble(byte[] bytes)
```
    Parses a double from a (big-endian) byte array.
    
    Parameters:
    
    bytes - The bytes representing the double.
    
    Returns:
    
    The double represented by the given bytes.
  - parseDouble
```
public static double parseDouble(byte[] bytes,
                                 int startIndex,
                                 int endIndex)
```
    Parses a double from a (big-endian) byte array.
    
    Parameters:
    
    bytes - The bytes representing the double.
    
    startIndex - Beginning of the double in the byte array.
    
    endIndex - End of the double in the byte array.
    
    Returns:
    
    The double represented by the given bytes.
  - copyOfRange
```
public static byte[] copyOfRange(byte[] src,
                                 int startIndex,
                                 int endIndex)
```
    Copies a part of a byte array into a new array.
    
    Parameters:
    
    src - The source array.
    
    startIndex - The index from which to start copying.
    
    endIndex - The index until which to copy.
    
    Returns:
    
    The copied array.
  - doParse
```
private NSObject doParse(byte[] data)
                  throws PropertyListFormatException,
                         java.io.UnsupportedEncodingException
```
    Parses a binary property list from a byte array.
    
    Parameters:
    
    data - The binary property list's data.
    
    Returns:
    
    The root object of the property list. This is usually a NSDictionary but can also be a NSArray.
    
    Throws:
    
    PropertyListFormatException - When the property list's format could not be parsed.
    
    java.io.UnsupportedEncodingException - If a NSString object could not be decoded.
  - parseObject
```
private NSObject parseObject(ParsedObjectStack stack,
                             int obj)
                      throws PropertyListFormatException,
                             java.io.UnsupportedEncodingException
```
    Parses an object inside the currently parsed binary property list. For the format specification check Apple's binary property list parser implementation.
    
    Parameters:
    
    stack - The stack to keep track of parsed objects and detect cyclic references.
    
    obj - The object ID.
    
    Returns:
    
    The parsed object.
    
    Throws:
    
    PropertyListFormatException - When the property list's format could not be parsed.
    
    java.io.UnsupportedEncodingException - If a NSString object could not be decoded.
  - parseDate
```
private NSDate parseDate(int offset,
                         int objInfo)
                  throws PropertyListFormatException
```
    Throws:
    
    PropertyListFormatException
  - parseData
```
private NSData parseData(int offset,
                         int objInfo)
                  throws PropertyListFormatException
```
    Throws:
    
    PropertyListFormatException
  - parseSimpleObject
```
private NSObject parseSimpleObject(int offset,
                                   int objInfo,
                                   int objType,
                                   int obj)
                            throws PropertyListFormatException
```
    Throws:
    
    PropertyListFormatException
  - parseUid
```
private UID parseUid(int obj,
                     int offset,
                     int length)
              throws PropertyListFormatException
```
    Throws:
    
    PropertyListFormatException
  - parseNumber
```
private NSNumber parseNumber(int offset,
                             int objInfo,
                             int integer)
                      throws PropertyListFormatException
```
    Throws:
    
    PropertyListFormatException
  - parseString
```
private NSString parseString(int offset,
                             int objInfo,
                             java.util.function.BiFunction<java.lang.Integer,java.lang.Integer,java.lang.Integer> stringLengthCalculator,
                             java.lang.String charsetName)
                      throws PropertyListFormatException,
                             java.io.UnsupportedEncodingException
```
    Throws:
    
    PropertyListFormatException
    
    java.io.UnsupportedEncodingException
  - parseArray
```
private NSArray parseArray(int offset,
                           int objInfo,
                           ParsedObjectStack stack)
                    throws PropertyListFormatException,
                           java.io.UnsupportedEncodingException
```
    Throws:
    
    PropertyListFormatException
    
    java.io.UnsupportedEncodingException
  - parseSet
```
private NSSet parseSet(int offset,
                       int objInfo,
                       boolean ordered,
                       ParsedObjectStack stack)
                throws PropertyListFormatException,
                       java.io.UnsupportedEncodingException
```
    Throws:
    
    PropertyListFormatException
    
    java.io.UnsupportedEncodingException
  - parseDictionary
```
private NSDictionary parseDictionary(int offset,
                                     int objInfo,
                                     ParsedObjectStack stack)
                              throws PropertyListFormatException,
                                     java.io.UnsupportedEncodingException
```
    Throws:
    
    PropertyListFormatException
    
    java.io.UnsupportedEncodingException
  - readLengthAndOffset
```
private int[] readLengthAndOffset(int objInfo,
                                  int offset)
                           throws PropertyListFormatException
```
    Throws:
    
    PropertyListFormatException
  - calculateUtf8StringLength
```
private int calculateUtf8StringLength(int offset,
                                      int numCharacters)
```
  - hastUtf8Sequence
```
private boolean hastUtf8Sequence(int offset,
                                 int n)
```
  - parseObjectReferenceFromList
```
private int parseObjectReferenceFromList(int baseOffset,
                                         int objectIndex)
                                  throws PropertyListFormatException
```
    Throws:
    
    PropertyListFormatException
  - parseObjectReference
```
private int parseObjectReference(int offset)
                          throws PropertyListFormatException
```
    Throws:
    
    PropertyListFormatException
  - getObjectOffset
```
private int getObjectOffset(int obj)
                     throws PropertyListFormatException
```
    Throws:
    
    PropertyListFormatException

Class BinaryPropertyListParser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SIMPLE_TYPE

INT_TYPE

REAL_TYPE

DATE_TYPE

DATA_TYPE

ASCII_STRING_TYPE

UTF16_STRING_TYPE

UTF8_STRING_TYPE

UID_TYPE

ARRAY_TYPE

ORDERED_SET_TYPE

SET_TYPE

DICTIONARY_TYPE

majorVersion

minorVersion

bytes

objectRefSize

offsetSize

numObjects

offsetTableOffset

parsedObjects

Constructor Detail

BinaryPropertyListParser

Method Detail

parse

parse

parse

parse

parseUnsignedInt

parseUnsignedInt

parseLong

parseLong

parseDouble

parseDouble

copyOfRange

doParse

parseObject

parseDate

parseData

parseSimpleObject

parseUid

parseNumber

parseString

parseArray

parseSet

parseDictionary

readLengthAndOffset

calculateUtf8StringLength

hastUtf8Sequence

parseObjectReferenceFromList

parseObjectReference

getObjectOffset