Package com.dd.plist

Class BinaryPropertyListWriter

java.lang.Object

com.dd.plist.BinaryPropertyListWriter

public final class BinaryPropertyListWriter
extends Object

Writes property lists in the binary format.

Field Summary

Fields

Modifier and Type	Field	Description
private long	count
private final Map<NSObject,Integer>	idMap
private int	idSizeInBytes
private final OutputStream	out
private int	version
private static final int	VERSION_00
private static final int	VERSION_10
private static final int	VERSION_15
private static final int	VERSION_20

Constructor Summary

Constructors

Constructor	Description
BinaryPropertyListWriter(OutputStream outStr, int version)	Creates a new binary property list writer

Method Summary

Modifier and Type	Method	Description
(package private) void	assignID(NSObject obj)
private static int	computeIdSizeInBytes(int numberOfIds)
private int	computeOffsetSizeInBytes(long maxOffset)
(package private) int	getID(NSObject obj)
private static int	getMinimumRequiredVersion(NSObject root)	Finds out the minimum binary property list format version that can be used to save the given NSObject tree.
(package private) void	write(byte[] bytes)
(package private) void	write(int b)
(package private) void	write(NSObject root)
static void	write(NSObject root, File file)	Writes a binary plist file with the given object as the root.
static void	write(NSObject root, File file, boolean createParentDirectories)	Writes a binary plist file with the given object as the root.
static void	write(NSObject root, OutputStream out)	Writes a binary plist serialization of the given object as the root.
static void	write(NSObject root, Path path)	Writes a binary plist file with the given object as the root.
static void	write(File file, NSObject root)	Deprecated. Use the overload that takes the root as first argument and the file as second.
static void	write(OutputStream out, NSObject root)	Deprecated. Use the overload that takes the root as first argument and the stream as second.
(package private) void	writeBytes(long value, int bytes)
(package private) void	writeDouble(double value)
(package private) void	writeID(int id)
(package private) void	writeIntHeader(int kind, int value)
(package private) void	writeLong(long value)
static byte[]	writeToArray(NSObject root)	Writes a binary plist serialization of the given object as the root into a byte array.

Methods inherited from class java.lang.Object

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

Field Details

VERSION_00

private static final int VERSION_00

See Also:

• Constant Field Values

VERSION_10

private static final int VERSION_10

See Also:

• Constant Field Values

VERSION_15

private static final int VERSION_15

See Also:

• Constant Field Values

VERSION_20

private static final int VERSION_20

See Also:

• Constant Field Values

version

private int version

out

private final OutputStream out

count

private long count

idMap

private final Map<NSObject,Integer> idMap

idSizeInBytes

private int idSizeInBytes

Constructor Details

BinaryPropertyListWriter

BinaryPropertyListWriter(OutputStream outStr,
 int version)

Creates a new binary property list writer

Parameters:

outStr - The output stream into which the binary property list will be written

version - The binary property list format version.

Method Details

getMinimumRequiredVersion

private static int getMinimumRequiredVersion(NSObject root)

Finds out the minimum binary property list format version that can be used to save the given NSObject tree.

Parameters:

root - Object root

Returns:

Version code

write

@Deprecated
public static void write(File file,
 NSObject root)
                  throws IOException

Deprecated.

Use the overload that takes the root as first argument and the file as second.

Writes a binary plist file with the given object as the root.

Parameters:

file - The file to write to.

root - The source of the data to write to the file.

Throws:

IOException - If an I/O error occurs while writing to the file or the object structure contains data that cannot be saved.

write

public static void write(NSObject root,
 File file)
                  throws IOException

Writes a binary plist file with the given object as the root.

Parameters:

root - The source of the data to write to the file.

file - The file to write to.

Throws:

IOException - If an I/O error occurs while writing to the file or the object structure contains data that cannot be saved.

write

public static void write(NSObject root,
 File file,
 boolean createParentDirectories)
                  throws IOException

Writes a binary plist file with the given object as the root.

Parameters:

root - The source of the data to write to the file.

file - The file to write to.

createParentDirectories - If set to true, the file's parent directories will be created.

Throws:

IOException - If an I/O error occurs while writing to the file or the object structure contains data that cannot be saved.

write

public static void write(NSObject root,
 Path path)
                  throws IOException

Writes a binary plist file with the given object as the root.

Parameters:

root - The source of the data to write to the file.

path - The path of the file to write to.

Throws:

IOException - If an I/O error occurs while writing to the file or the object structure contains data that cannot be saved.

write

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

Deprecated.

Use the overload that takes the root as first argument and the stream as second.

Writes a binary plist serialization of the given object as the root. This method does not close the output stream.

Parameters:

out - The stream to write to.

root - The source of the data to write to the stream.

Throws:

IOException - If an I/O error occurs while writing to the stream or the object structure contains data that cannot be saved.

write

public static void write(NSObject root,
 OutputStream out)
                  throws IOException

Writes a binary plist serialization of the given object as the root. This method does not close the output stream.

Parameters:

root - The source of the data to write to the stream.

out - The stream to write to.

Throws:

IOException - If an I/O error occurs while writing to the stream or the object structure contains data that cannot be saved.

writeToArray

public static byte[] writeToArray(NSObject root)
                           throws IOException

Writes a binary plist serialization of the given object as the root into a byte array.

Parameters:

root - The root object of the property list

Returns:

The byte array containing the serialized property list

Throws:

IOException - If an I/O error occurs while writing to the stream or the object structure contains data that cannot be saved.

write

void write(NSObject root)
    throws IOException

Throws:

IOException

assignID

void assignID(NSObject obj)

getID

int getID(NSObject obj)

computeIdSizeInBytes

private static int computeIdSizeInBytes(int numberOfIds)

computeOffsetSizeInBytes

private int computeOffsetSizeInBytes(long maxOffset)

writeIntHeader

void writeIntHeader(int kind,
 int value)
             throws IOException

Throws:

IOException

write

void write(int b)
    throws IOException

Throws:

IOException

write

void write(byte[] bytes)
    throws IOException

Throws:

IOException

writeBytes

void writeBytes(long value,
 int bytes)
         throws IOException

Throws:

IOException

writeID

void writeID(int id)
      throws IOException

Throws:

IOException

writeLong

void writeLong(long value)
        throws IOException

Throws:

IOException

writeDouble

void writeDouble(double value)
          throws IOException

Throws:

IOException