net.sf.plist.io.bin

Class BinaryWriter

java.lang.Object

net.sf.plist.io.PropertyListWriter

net.sf.plist.io.bin.BinaryWriter

public class BinaryWriter
extends PropertyListWriter

Serializes a tree consisting of NSObjects to a binary property list

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.plist.io.PropertyListWriter

PropertyListWriter.Format

Field Summary

Fields

Modifier and Type	Field and Description
static byte	ARRAY Byte mask indicating a array value
static java.nio.charset.Charset	ASCIICHARSET Charset to parse ASCII strings
static java.util.regex.Pattern	ASCIIPATTERN Pattern used to determine whether a string contains only ASCII characters
static byte	ASCIISTRING Byte mask indicating a ascii string value
static byte	BOOLFALSE Byte indicating a Boolean.FALSE value
static byte	BOOLTRUE Byte indicating a Boolean.TRUE value
static byte	DATA Byte mask indicating a binary data value
static byte	DATE Byte mask indicating a date value
static byte	DICT Byte mask indicating a dictionary value
static byte	FILL Filler byte
static byte	INT Byte mask indicating a integer value
static byte	LENMASK Mask for extracting the length
static byte	NULL NULL byte
protected int	numObjects Number of objects in stream
protected java.util.List<NSObject>	objectIndex Numbered list containing all objects
static byte	OBJMASK Mask for extracting the objecttype (result must be shifted right 4 bits)
protected byte	objRefSize Size of object references in bytes
protected byte	offsetEntrySize Size of offset entries in bytes
protected int[]	offsetTable The offset table
protected int	pointer The amount of bytes written
static byte	REAL Byte mask indicating a real value
static byte	SET Byte mask indicating a set value (not implemented)
protected static byte[]	STARTMAGIC Bytes expected at the start of the file
protected java.io.OutputStream	stream The outputstream
static byte	UID Byte mask indicating a uid value (not implemented)
static java.nio.charset.Charset	UNICODECHARSET Charset to parse unicode strings
static byte	UNICODESTRING Byte mask indicating a unicode string value

Fields inherited from class net.sf.plist.io.PropertyListWriter

defaultFormat, root

Constructor Summary

Constructors

Constructor and Description
BinaryWriter(NSObject root)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	buildObjectIndex(NSObject... objs) Add all objects to the objectIndex, and search all objects of type NSDictionary or NSArray for more.
protected void	buildObjectIndex(java.lang.String... strings) Add all strings to the objectIndex as NSStrings
protected static byte	getLongLength(long l) Get amount of bytes required to represent a long
protected static byte	log2ceil(long l) Calculate the 2log of a long, rounded up to the nearest integer or minimal result
protected static byte[]	longToByteArray(long l, byte size) Split a long into bytes, little endian
void	write(java.io.OutputStream stream) Write the property list to a stream
protected long	writeArray(NSArray obj) Write an array to the stream
protected long	writeBoolean(NSBoolean obj) Write a boolean to the stream
protected long	writeData(NSData obj) Write a data object to the stream
protected long	writeDate(NSDate obj) Write date to the stream
protected long	writeDictionary(NSDictionary obj) Write a dictionary to the stream
protected long	writeInteger(NSInteger obj) Write an integer to the stream
protected long	writeObject(NSObject obj) Write an object to the stream
protected long	writeObjectHeader(long length, byte type) Write the object header consisting of the type and length to the stream
protected long	writeReal(NSReal obj) Write a real to the stream
protected long	writeString(NSString obj) Write a string to the stream

Methods inherited from class net.sf.plist.io.PropertyListWriter

write, write, write

Methods inherited from class java.lang.Object

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

Field Detail

objectIndex

protected final java.util.List<NSObject> objectIndex

Numbered list containing all objects

STARTMAGIC

protected static final byte[] STARTMAGIC

Bytes expected at the start of the file

ASCIIPATTERN

public static final java.util.regex.Pattern ASCIIPATTERN

Pattern used to determine whether a string contains only ASCII characters

offsetEntrySize

protected byte offsetEntrySize

Size of offset entries in bytes

objRefSize

protected byte objRefSize

Size of object references in bytes

numObjects

protected int numObjects

Number of objects in stream

offsetTable

protected int[] offsetTable

The offset table

pointer

protected int pointer

The amount of bytes written

stream

protected java.io.OutputStream stream

The outputstream

NULL

public static final byte NULL

NULL byte

See Also:

Constant Field Values

BOOLFALSE

public static final byte BOOLFALSE

Byte indicating a Boolean.FALSE value

See Also:

Constant Field Values

BOOLTRUE

public static final byte BOOLTRUE

Byte indicating a Boolean.TRUE value

See Also:

Constant Field Values

FILL

public static final byte FILL

Filler byte

See Also:

Constant Field Values

INT

public static final byte INT

Byte mask indicating a integer value

See Also:

Constant Field Values

REAL

public static final byte REAL

Byte mask indicating a real value

See Also:

Constant Field Values

DATE

public static final byte DATE

Byte mask indicating a date value

See Also:

Constant Field Values

DATA

public static final byte DATA

Byte mask indicating a binary data value

See Also:

Constant Field Values

ASCIISTRING

public static final byte ASCIISTRING

Byte mask indicating a ascii string value

See Also:

Constant Field Values

UNICODESTRING

public static final byte UNICODESTRING

Byte mask indicating a unicode string value

See Also:

Constant Field Values

UID

public static final byte UID

Byte mask indicating a uid value (not implemented)

See Also:

Constant Field Values

ARRAY

public static final byte ARRAY

Byte mask indicating a array value

See Also:

Constant Field Values

SET

public static final byte SET

Byte mask indicating a set value (not implemented)

See Also:

Constant Field Values

DICT

public static final byte DICT

Byte mask indicating a dictionary value

See Also:

Constant Field Values

OBJMASK

public static final byte OBJMASK

Mask for extracting the objecttype (result must be shifted right 4 bits)

See Also:

Constant Field Values

LENMASK

public static final byte LENMASK

Mask for extracting the length

See Also:

Constant Field Values

ASCIICHARSET

public static final java.nio.charset.Charset ASCIICHARSET

Charset to parse ASCII strings

UNICODECHARSET

public static final java.nio.charset.Charset UNICODECHARSET

Charset to parse unicode strings

Constructor Detail

BinaryWriter

public BinaryWriter(NSObject root)

See Also:

PropertyListWriter.PropertyListWriter(NSObject)

Method Detail

getLongLength

protected static byte getLongLength(long l)

Get amount of bytes required to represent a long

Parameters:

l - the long

Returns:

the amount of bytes required

longToByteArray

protected static byte[] longToByteArray(long l,
                     byte size)

Split a long into bytes, little endian

Parameters:

l - the long

size - the amount of bytes to output

Returns:

the bytes that make up the long

log2ceil

protected static byte log2ceil(long l)

Calculate the 2log of a long, rounded up to the nearest integer or minimal result

Parameters:

l - the long

Returns:

the 2log

write

public void write(java.io.OutputStream stream)
           throws PropertyListException,
                  java.io.IOException

Write the property list to a stream

Specified by:

write in class PropertyListWriter

Parameters:

stream - the stream to write the property list to

Throws:

PropertyListException - when generating the property list fails

java.io.IOException - when writing to the stream fails

writeObject

protected long writeObject(NSObject obj)
                    throws PropertyListException,
                           java.io.IOException

Write an object to the stream

Parameters:

obj - the object to write

Returns:

the amount of bytes written

Throws:

PropertyListException - if the object could not be converted to binary data

java.io.IOException - if an I/O error occurs

writeObjectHeader

protected long writeObjectHeader(long length,
                     byte type)
                          throws java.io.IOException

Write the object header consisting of the type and length to the stream

Parameters:

length - the length of the object (units differ between objects)

type - the 4 bits determining the type of the object

Returns:

the amount of bytes written

Throws:

java.io.IOException - if an I/O error occurs

writeArray

protected long writeArray(NSArray obj)
                   throws java.io.IOException

Write an array to the stream

Parameters:

obj - the array

Returns:

the amount of bytes written

Throws:

java.io.IOException - if an I/O error occurs

writeBoolean

protected long writeBoolean(NSBoolean obj)
                     throws java.io.IOException

Write a boolean to the stream

Parameters:

obj - the boolean

Returns:

the amount of bytes written

Throws:

java.io.IOException - if an I/O error occurs

writeData

protected long writeData(NSData obj)
                  throws java.io.IOException

Write a data object to the stream

Parameters:

obj - the data object

Returns:

the amount of bytes written

Throws:

java.io.IOException - if an I/O error occurs

writeDate

protected long writeDate(NSDate obj)
                  throws java.io.IOException

Write date to the stream

Parameters:

obj - the date

Returns:

the amount of bytes written

Throws:

java.io.IOException - if an I/O error occurs

writeDictionary

protected long writeDictionary(NSDictionary obj)
                        throws java.io.IOException

Write a dictionary to the stream

Parameters:

obj - the dictionary

Returns:

the amount of bytes written

Throws:

java.io.IOException - if an I/O error occurs

writeInteger

protected long writeInteger(NSInteger obj)
                     throws java.io.IOException

Write an integer to the stream

Parameters:

obj - the integer

Returns:

the amount of bytes written

Throws:

java.io.IOException - if an I/O error occurs

writeReal

protected long writeReal(NSReal obj)
                  throws java.io.IOException

Write a real to the stream

Parameters:

obj - the real

Returns:

the amount of bytes written

Throws:

java.io.IOException - if an I/O error occurs

writeString

protected long writeString(NSString obj)
                    throws java.io.IOException

Write a string to the stream

Parameters:

obj - the string

Returns:

the amount of bytes written

Throws:

java.io.IOException - if an I/O error occurs

buildObjectIndex

protected void buildObjectIndex(NSObject... objs)

Add all objects to the objectIndex, and search all objects of type NSDictionary or NSArray for more.

Parameters:

objs - the objects

buildObjectIndex

protected void buildObjectIndex(java.lang.String... strings)

Add all strings to the objectIndex as NSStrings

Parameters:

strings - the strings