net.sf.plist

Class NSArray

java.lang.Object

net.sf.plist.NSObject

net.sf.plist.NSCollection

net.sf.plist.NSArray

public final class NSArray
extends NSCollection

Ordered list of NSObjects.

In this implementation, a List is used to represent the NSArray.

See Also:

List

Constructor Summary

Constructors

Constructor and Description
NSArray(java.util.Collection<? extends NSObject> theList) Constructor.
NSArray(NSObject[] theList) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
NSObject[]	array() Get an array containing all values of this object.
static NSArray	fromList(java.util.List<?> list) Convert a list to an NSArray.
NSObject	get(int index) Get NSObject corresponding to index from this object.
java.util.List<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() Get an unmodifiable List containing all values of this object.
long	toLong() Return the value as a long.
java.util.SortedMap<java.lang.String,NSObject>	toMap() Try to retrieve the SortedMap contained in this NSObject.
java.util.List<java.lang.Object>	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

NSArray

public NSArray(java.util.Collection<? extends NSObject> theList)

Constructor.

Parameters:

theList - the contents of new object

NSArray

public NSArray(NSObject[] theList)

Constructor.

Parameters:

theList - the contents of new object

Method Detail

get

public NSObject get(int index)

Get NSObject corresponding to index from this object.

Parameters:

index - index of object to retrieve

toList

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

Get an unmodifiable List containing all values of this object. This List cannot be modified, but can be used to instantiate a new ArrayList and then used to create a new NSArray. Each subsequent call to toList() will create a new ArrayList. Use getValue() to get an unmodifiable List.

Overrides:

toList in class NSObject

Returns:

the List

See Also:

getValue()

array

public NSObject[] array()

Get an array containing all values of this object. Changes made in the array will not affect this object.

When iterating through all items in this object, the toList() method is a better choice for performance reasons.

Returns:

the array

toObject

public java.util.List<java.lang.Object> 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

getValue

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

Get the unmodifiable value of this object.

Specified by:

getValue in class NSObject

Returns:

the unmodifiable value of this object

See Also:

toList()

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

toMap

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

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

Overrides:

toMap in class NSObject

Returns:

the list

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

fromList

public static NSArray fromList(java.util.List<?> list)

Convert a list to an NSArray. 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.