dd-plist 1.29 · com.dd.plist.NSObject · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
pack-priv static final int	ASCII_LINE_LENGTH The maximum length of the text lines to be used when generating ASCII property lists.
private static final String	INDENT The indentation character used for generating the XML output.
private LocationInformation	locationInformation
pack-priv static final String	NEWLINE The newline character used for generating the XML output.

Access	Constructor and Description
public	NSObject()

Method Summary

Modifier and Type	Method and Description
pack-priv void	assignIDs(BinaryPropertyListWriter The writer object that handles the binary serialization. out) Assigns IDs to all the objects in this NSObject subtree.
public abstract NSObject	Returns: A clone of this instance. clone() Overrides java.lang.Object.clone. Creates and returns a deep copy of this instance.
private Object	deserializeArray(NSObject payload, Class<?> clazz)
private Object	deserializeCollection(NSObject payload, Class<?> clazz, Type[] types)
private static Object	deserializeData(NSData payload, Class<?> elementClass)
private static Date	deserializeDate(NSDate date, Class<?> clazz)
private Object	deserializeMap(Class<?> clazz, Type[] types, Map<String, NSObject> map)
private static Object	deserializeNumber(final NSNumber number, Class<?> clazz)
private Object	deserializeObject(NSDictionary payload, Class<?> clazz, Type[] types)
private static Object	deserializeSimple(NSObject payload, Class<?> clazz)
private static NSObject	fromArray(Object object, Class<?> objClass)
private static NSArray	fromCollection(Collection<?> collection)
private static NSData	fromData(Object object)
public static NSObject	Returns: A NSObject instance. fromJavaObject(Object The object to serialize. object) Serializes the specified object into an NSObject.
private static NSDictionary	fromMap(Map<?, ?> map)
private static NSDictionary	fromPojo(Object object, Class<?> objClass)
private static NSSet	fromSet(Set<?> set)
private static NSObject	fromSimple(Object object, Class<?> objClass)
private static Class<?>	getClassForName(String className)
private static Object	getInstance(Class<?> clazz)
public LocationInformation	Returns: The location information, or `null` if it is not available. getLocationInformation() Gets information about the location of this NSObject within the parsed property list, if available.
protected void	indent(StringBuilder The `StringBuilder` onto which the XML representation is appended. xml, int The level of indentation. level) Helper method that adds correct indentation to the xml output.
private static boolean	isSimple(Class<?> clazz)
private static String	makeFirstCharLowercase(String input)
pack-priv void	setLocationInformation(LocationInformation The location information. locationInformation) Sets the location information.
pack-priv abstract void	toASCII(StringBuilder The `StringBuilder` onto which the ASCII representation is appended. ascii, int The indentation level of the object. level) Generates the ASCII representation of this object.
pack-priv abstract void	toASCIIGnuStep(StringBuilder The `StringBuilder` onto which the ASCII representation is appended. ascii, int The indentation level of the object. level) Generates the ASCII representation of this object in the GnuStep format.
pack-priv abstract void	toBinary(BinaryPropertyListWriter The output stream to serialize the object to. out) Generates the binary representation of the object.
public abstract Object	Returns: A native java object representing this NSObject's value. toJavaObject() Converts this NSObject into an equivalent object of the Java Runtime Environment.
public < The target object type. T> T	Returns: A new instance of the specified class, deserialized from this NSObject. toJavaObject(Class<T> The target class. clazz) Converts this NSObject into an object of the specified class.
private Object	toJavaObject(NSObject payload, Class<?> clazz, Type[] types)
pack-priv abstract void	toXML(StringBuilder The `StringBuilder` onto which the XML representation is appended. xml, int The indentation level of the object. level) Generates the XML representation of the object (without XML headers or enclosing plist-tags).
public String	Returns: The XML representation of the property list including XML header and doctype information. toXMLPropertyList() Generates a valid XML property list including headers using this object as root.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

ASCII_LINE_LENGTH	back to summary
pack-priv static final int ASCII_LINE_LENGTH The maximum length of the text lines to be used when generating ASCII property lists. But this number is only a guideline it is not guaranteed that it will not be overstepped.

INDENT	back to summary
private static final String INDENT The indentation character used for generating the XML output. This is the tabulator character.

locationInformation	back to summary
private LocationInformation locationInformation

NEWLINE	back to summary
pack-priv static final String NEWLINE The newline character used for generating the XML output. This constant will be different depending on the operating system on which you use this library.

NSObject	back to summary
public NSObject()

Method Detail

assignIDs	back to summary
pack-priv void assignIDs(BinaryPropertyListWriter out) Assigns IDs to all the objects in this NSObject subtree. Parameters out:BinaryPropertyListWriter The writer object that handles the binary serialization.

assignIDs

back to summary

pack-priv void assignIDs(BinaryPropertyListWriter out)

Assigns IDs to all the objects in this NSObject subtree.

Parameters

out:BinaryPropertyListWriter: The writer object that handles the binary serialization.

clone	back to summary
public abstract NSObject clone() Overrides java.lang.Object.clone. Creates and returns a deep copy of this instance. Returns:NSObject A clone of this instance. Annotations @Override

clone

back to summary

public abstract NSObject clone()

Overrides java.lang.Object.clone.

Creates and returns a deep copy of this instance.

Returns:NSObject

A clone of this instance.

Annotations

@Override

deserializeArray	back to summary
private Object deserializeArray(NSObject payload, Class<?> clazz)

deserializeCollection	back to summary
private Object deserializeCollection(NSObject payload, Class<?> clazz, Type[] types)

deserializeData	back to summary
private static Object deserializeData(NSData payload, Class<?> elementClass)

deserializeDate	back to summary
private static Date deserializeDate(NSDate date, Class<?> clazz)

deserializeMap	back to summary
private Object deserializeMap(Class<?> clazz, Type[] types, Map<String, NSObject> map)

deserializeNumber	back to summary
private static Object deserializeNumber(final NSNumber number, Class<?> clazz)

deserializeObject	back to summary
private Object deserializeObject(NSDictionary payload, Class<?> clazz, Type[] types)

deserializeSimple	back to summary
private static Object deserializeSimple(NSObject payload, Class<?> clazz)

fromArray	back to summary
private static NSObject fromArray(Object object, Class<?> objClass)

fromCollection	back to summary
private static NSArray fromCollection(Collection<?> collection)

fromData	back to summary
private static NSData fromData(Object object)

fromJavaObject back to summary

fromJavaObject	back to summary
public static NSObject fromJavaObject(Object object) Serializes the specified object into an NSObject. Objects which do not have a direct type correspondence to an NSObject type will be serialized as a `NSDictionary`. The dictionary will contain the values of all publicly accessible fields and properties. Parameters object:Object The object to serialize. Returns:NSObject A NSObject instance. Exceptions IllegalArgumentException: If the specified object throws an exception while getting its properties.

public static NSObject fromJavaObject(Object object)

Serializes the specified object into an NSObject. Objects which do not have a direct type correspondence to an NSObject type will be serialized as a NSDictionary. The dictionary will contain the values of all publicly accessible fields and properties.

Parameters

object:Object: The object to serialize.

Returns:NSObject

A NSObject instance.

Exceptions

IllegalArgumentException:: If the specified object throws an exception while getting its properties.

fromMap	back to summary
private static NSDictionary fromMap(Map<?, ?> map)

fromPojo	back to summary
private static NSDictionary fromPojo(Object object, Class<?> objClass)

fromSet	back to summary
private static NSSet fromSet(Set<?> set)

fromSimple	back to summary
private static NSObject fromSimple(Object object, Class<?> objClass) Annotations @SuppressWarnings:ConstantConditions

getClassForName	back to summary
private static Class<?> getClassForName(String className)

getInstance	back to summary
private static Object getInstance(Class<?> clazz)

getLocationInformation back to summary

getLocationInformation	back to summary
public LocationInformation getLocationInformation() Gets information about the location of this NSObject within the parsed property list, if available. Returns:LocationInformation The location information, or `null` if it is not available.

public LocationInformation getLocationInformation()

Gets information about the location of this NSObject within the parsed property list, if available.

Returns:LocationInformation: The location information, or null if it is not available.

indent back to summary

indent	back to summary
protected void indent(StringBuilder xml, int level) Helper method that adds correct indentation to the xml output. Calling this method will add `level` number of tab characters to the `xml` string. Parameters xml:StringBuilder The `StringBuilder` onto which the XML representation is appended. level:int The level of indentation.

protected void indent(StringBuilder xml, int level)

Helper method that adds correct indentation to the xml output. Calling this method will add level number of tab characters to the xml string.

Parameters

xml:StringBuilder: The StringBuilder onto which the XML representation is appended.
level:int: The level of indentation.

isSimple	back to summary
private static boolean isSimple(Class<?> clazz)

makeFirstCharLowercase	back to summary
private static String makeFirstCharLowercase(String input)

setLocationInformation	back to summary
pack-priv void setLocationInformation(LocationInformation locationInformation) Sets the location information. Parameters locationInformation:LocationInformation The location information.

setLocationInformation

back to summary

pack-priv void setLocationInformation(LocationInformation locationInformation)

Sets the location information.

Parameters

locationInformation:LocationInformation: The location information.

toASCII back to summary

toASCII	back to summary
pack-priv abstract void toASCII(StringBuilder ascii, int level) Generates the ASCII representation of this object. The generated ASCII representation does not end with a newline. Complies with the Old-Style ASCII Property Lists definition. Parameters ascii:StringBuilder The `StringBuilder` onto which the ASCII representation is appended. level:int The indentation level of the object.

pack-priv abstract void toASCII(StringBuilder ascii, int level)

Generates the ASCII representation of this object. The generated ASCII representation does not end with a newline. Complies with the Old-Style ASCII Property Lists definition.

Parameters

ascii:StringBuilder: The StringBuilder onto which the ASCII representation is appended.
level:int: The indentation level of the object.

toASCIIGnuStep back to summary

toASCIIGnuStep	back to summary
pack-priv abstract void toASCIIGnuStep(StringBuilder ascii, int level) Generates the ASCII representation of this object in the GnuStep format. The generated ASCII representation does not end with a newline. Parameters ascii:StringBuilder The `StringBuilder` onto which the ASCII representation is appended. level:int The indentation level of the object.

pack-priv abstract void toASCIIGnuStep(StringBuilder ascii, int level)

Generates the ASCII representation of this object in the GnuStep format. The generated ASCII representation does not end with a newline.

Parameters

ascii:StringBuilder: The StringBuilder onto which the ASCII representation is appended.
level:int: The indentation level of the object.

toBinary	back to summary
pack-priv abstract void toBinary(BinaryPropertyListWriter out) throws IOException Generates the binary representation of the object. Parameters out:BinaryPropertyListWriter The output stream to serialize the object to. Exceptions IOException: If an I/O error occurs while writing to the stream or the object structure contains data that cannot be saved.

toBinary

back to summary

pack-priv abstract void toBinary(BinaryPropertyListWriter out) throws IOException

Generates the binary representation of the object.

Parameters

out:BinaryPropertyListWriter: The output stream to serialize the object to.

Exceptions

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

toJavaObject back to summary

toJavaObject	back to summary
public abstract Object toJavaObject() Converts this NSObject into an equivalent object of the Java Runtime Environment. `NSArray` objects are converted to arrays. `NSDictionary` objects are converted to objects extending the `java.util.Map` class. `NSSet` objects are converted to objects extending the `java.util.Set` class. `NSNumber` objects are converted to primitive number values (int, long, double or boolean). `NSString` objects are converted to `String` objects. `NSData` objects are converted to byte arrays. `NSDate` objects are converted to `java.util.Date` objects. `UID` objects are converted to byte arrays. Returns:Object A native java object representing this NSObject's value.

public abstract Object toJavaObject()

Converts this NSObject into an equivalent object of the Java Runtime Environment.

NSArray objects are converted to arrays.
NSDictionary objects are converted to objects extending the java.util.Map class.
NSSet objects are converted to objects extending the java.util.Set class.
NSNumber objects are converted to primitive number values (int, long, double or boolean).
NSString objects are converted to String objects.
NSData objects are converted to byte arrays.
NSDate objects are converted to java.util.Date objects.
UID objects are converted to byte arrays.

Returns:Object: A native java object representing this NSObject's value.

toJavaObject	back to summary
public <T> T toJavaObject(Class<T> clazz) Converts this NSObject into an object of the specified class. Parameters <T> The target object type. clazz:Class<T> The target class. Returns:T A new instance of the specified class, deserialized from this NSObject. Annotations @SuppressWarnings:unchecked Exceptions IllegalArgumentException: If the specified class cannot be deserialized from this NSObject.

toJavaObject

back to summary

public <T> T toJavaObject(Class<T> clazz)

Converts this NSObject into an object of the specified class.

Parameters

<T>: The target object type.
clazz:Class<T>: The target class.

Returns:T

A new instance of the specified class, deserialized from this NSObject.

Annotations

@SuppressWarnings:unchecked

Exceptions

IllegalArgumentException:: If the specified class cannot be deserialized from this NSObject.

toJavaObject	back to summary
private Object toJavaObject(NSObject payload, Class<?> clazz, Type[] types)

toXML back to summary

toXML	back to summary
pack-priv abstract void toXML(StringBuilder xml, int level) Generates the XML representation of the object (without XML headers or enclosing plist-tags). Parameters xml:StringBuilder The `StringBuilder` onto which the XML representation is appended. level:int The indentation level of the object.

pack-priv abstract void toXML(StringBuilder xml, int level)

Generates the XML representation of the object (without XML headers or enclosing plist-tags).

Parameters

xml:StringBuilder: The StringBuilder onto which the XML representation is appended.
level:int: The indentation level of the object.

toXMLPropertyList	back to summary
public String toXMLPropertyList() Generates a valid XML property list including headers using this object as root. Returns:String The XML representation of the property list including XML header and doctype information.

toXMLPropertyList

back to summary

public String toXMLPropertyList()

Generates a valid XML property list including headers using this object as root.

Returns:String: The XML representation of the property list including XML header and doctype information.

public abstract Class NSObject

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail