net.sf.plist

Class NSDictionary

java.lang.Object

net.sf.plist.NSObject

net.sf.plist.NSCollection

net.sf.plist.NSDictionary

public final class NSDictionary
extends NSCollection

A key/value store, with String as keys and NSObject as values.
Usually, the root node of a Property List is a NSDictionary.

In this implementation, a SortedMap is used to represent the NSDictionary.

See Also:

SortedMap

Constructor Summary

Constructors

Constructor and Description
NSDictionary(java.util.Map<java.lang.String,? extends NSObject> map) Standard constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set<java.util.Map.Entry<java.lang.String,NSObject>>	entrySet() Get the entryset for this NSObject.
static NSDictionary	fromMap(java.util.Map<java.lang.String,?> map) Convert a map to a NSDictionary.
NSObject	get(java.lang.String key) Get the NSObject associated with key.
java.util.SortedMap<java.lang.String,NSObject>	getValue() Get the unmodifiable value of this object.
boolean	isTrue() Return whether or not the value evaluates to true.
double	toDouble() Return the value as a double.
java.util.List<NSObject>	toList() Try to retrieve the list contained in this NSObject.
long	toLong() Return the value as a long.
java.util.SortedMap<java.lang.String,NSObject>	toMap() Get an unlinked modifiable SortedMap containing all values of this object.
java.util.SortedMap<java.lang.String,?>	toObject() Converts this NSObject to a normal Java object.

Methods inherited from class net.sf.plist.NSCollection

toBytes

Methods inherited from class net.sf.plist.NSObject

equals, fromObject, hashCode, toBoolean, toDate, toInteger, toListObject, toMapObject, toNumber, toStream, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NSDictionary

public NSDictionary(java.util.Map<java.lang.String,? extends NSObject> map)

Standard constructor. Needs a SortedMap in order to keep the ordering.

Parameters:

map - value of the new object

Method Detail

fromMap

public static NSDictionary fromMap(java.util.Map<java.lang.String,?> map)

Convert a map to a NSDictionary. In order for this to work, the value objects must be of one of these types: - a java.lang object representing a primitive type - a NSObject - a Map or List which follows the same rules NSObject.getValue() always returns a valid object.

get

public NSObject get(java.lang.String key)

Get the NSObject associated with key.

Parameters:

key - The key to retrieve

Returns:

The NSObject associated with key

See Also:

Map.get(Object)

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,NSObject>> entrySet()

Get the entryset for this NSObject.

Returns:

the entryset

See Also:

Map.entrySet()

getValue

public java.util.SortedMap<java.lang.String,NSObject> getValue()

Get the unmodifiable value of this object.

Specified by:

getValue in class NSObject

Returns:

the unmodifiable value of this object

See Also:

toMap()

toMap

public java.util.SortedMap<java.lang.String,NSObject> toMap()

Get an unlinked modifiable SortedMap containing all values of this object. This SortedMap can be modified and then used to create a new NSDictionary. Each subsequent call to toMap() will create a new SortedMap. Use getValue() to get an unmodifiable SortedMap.

Overrides:

toMap in class NSObject

Returns:

the SortedMap

See Also:

getValue()

toObject

public java.util.SortedMap<java.lang.String,?> toObject()

Converts this NSObject to a normal Java object. The result of this method can be used as an argument in NSObject.fromObject(Object) which will convert the object back to an NSObject. Note: This method will NOT convert NSUID objects, because there is no Java equivalent for those.

Overrides:

toObject in class NSObject

Returns:

a standard Java object

toList

public java.util.List<NSObject> toList()

Try to retrieve the list contained in this NSObject. This method will return the list if the object is a NSArray and will return a list containing all the values (but without the keys) if this object is a NSDictionary. Otherwise an empty list is returned.

Overrides:

toList in class NSObject

Returns:

the list

isTrue

public boolean isTrue()

Return whether or not the value evaluates to true.

A value returns to true if and only if

• it is the NSBoolean type NSBoolean.TRUE
• It is an NSString which has a length greater than zero and does not equal "NO" or "False" (case insensitive)
• It is an NSNumber greater than 0
• It is an NSCollection which contains more than zero elements
• It is an NSDate
• It is an NSData with a length greater than 0

Specified by:

isTrue in class NSObject

Returns:

the value evaluates to true

toLong

public long toLong()

Return the value as a long. If this is not a NSInteger the long value is derived from the actual value.

Specified by:

toLong in class NSObject

Returns:

the long

toDouble

public double toDouble()

Return the value as a double. If this is not a NSReal the double value is derived from the actual value.

Specified by:

toDouble in class NSObject

Returns:

the double