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

Modifier and Type	Field and Description
private NSObject[]	array

Access	Constructor and Description
public	NSArray(int The number of elements the NSArray instance will be able to hold. length) Creates a new NSArray instance of the specified size.
public	NSArray(NSObject... The elements to be contained by the NSArray instance. a) Creates a new NSArray instance containing the specified elements.

Method Summary

Modifier and Type	Method and Description
pack-priv void	assignIDs(BinaryPropertyListWriter out) Overrides com.dd.plist.NSObject.assignIDs. Assigns IDs to all the objects in this NSObject subtree.
public NSArray	clone() Implements abstract com.dd.plist.NSObject.clone. Creates and returns a deep copy of this instance.
public int	compareTo(NSObject o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public boolean	Returns: `true`, when the object could be found. `false` otherwise. containsObject(Object The object to look for. obj) Checks whether an object is present in the array or whether it is equal to any of the objects in the array.
public int	Returns: The number of elements that this array can store. count() Returns the size of the array.
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public NSObject[]	Returns: The actual array represented by this NSArray. getArray() Returns the array of NSObjects represented by this NSArray.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public int	Returns: The index of the object, if it was found. -1 otherwise. indexOfIdenticalObject(Object The object to look for. obj) Searches for a specific object in the array.
public int	Returns: The index of the object, if it was found. -1 otherwise. indexOfObject(Object The object to look for. obj) Searches for an object in the array.
public NSObject	Returns: The value of the highest index in the array. lastObject() Returns the last object contained in this array.
public NSObject	Returns: The object at the given index. objectAtIndex(int The index of the object. i) Returns the object stored at the given index.
public NSObject[]	Returns: The new array containing the objects stored at the given indices. objectsAtIndexes(int... The indices of the objects. indexes) Returns a new array containing only the values stored at the given indices.
public void	remove(int The index of the object i) Removes the i-th element from the array.
public void	setValue(int The index where to store the object. key, Object The object. value) Stores an object at the specified index.
protected void	toASCII(StringBuilder ascii, int level) Implements abstract com.dd.plist.NSObject.toASCII. Generates the ASCII representation of this object.
private void	toASCII(StringBuilder ascii, int level, boolean gnustep)
protected void	toASCIIGnuStep(StringBuilder ascii, int level) Implements abstract com.dd.plist.NSObject.toASCIIGnuStep. Generates the ASCII representation of this object in the GnuStep format.
public String	Returns: ASCII representation of this object. toASCIIPropertyList() Generates a valid ASCII property list which has this NSArray as its root object.
pack-priv void	toBinary(BinaryPropertyListWriter out) Implements abstract com.dd.plist.NSObject.toBinary. Generates the binary representation of the object.
public String	Returns: GnuStep ASCII representation of this object. toGnuStepASCIIPropertyList() Generates a valid ASCII property list in GnuStep format which has this NSArray as its root object.
public Object	toJavaObject() Implements abstract com.dd.plist.NSObject.toJavaObject. Converts this NSObject into an equivalent object of the Java Runtime Environment.
pack-priv void	toXML(StringBuilder xml, int level) Implements abstract com.dd.plist.NSObject.toXML. Generates the XML representation of the object (without XML headers or enclosing plist-tags).

Inherited from com.dd.plist.NSObject:: fromJavaObject getLocationInformation indent setLocationInformation toJavaObject toXMLPropertyList

array	back to summary
private NSObject[] array

NSArray	back to summary
public NSArray(int length) Creates a new NSArray instance of the specified size. Parameters length:int The number of elements the NSArray instance will be able to hold.

NSArray	back to summary
public NSArray(NSObject... a) Creates a new NSArray instance containing the specified elements. Parameters a:NSObject[] The elements to be contained by the NSArray instance.

Method Detail

assignIDs	back to summary
pack-priv void assignIDs(BinaryPropertyListWriter out) Overrides com.dd.plist.NSObject.assignIDs. Doc from com.dd.plist.NSObject.assignIDs. Assigns IDs to all the objects in this NSObject subtree. Annotations @Override

assignIDs

back to summary

pack-priv void assignIDs(BinaryPropertyListWriter out)

Overrides com.dd.plist.NSObject.assignIDs.

Doc from com.dd.plist.NSObject.assignIDs.

Assigns IDs to all the objects in this NSObject subtree.

Annotations

@Override

clone	back to summary
public NSArray clone() Implements abstract com.dd.plist.NSObject.clone. Doc from com.dd.plist.NSObject.clone. Creates and returns a deep copy of this instance. Annotations @Override

clone

back to summary

public NSArray clone()

Implements abstract com.dd.plist.NSObject.clone.

Doc from com.dd.plist.NSObject.clone.

Creates and returns a deep copy of this instance.

Annotations

@Override

compareTo back to summary

compareTo	back to summary
public int compareTo(NSObject o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Annotations @Override

public int compareTo(NSObject o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Annotations

@Override

containsObject back to summary

containsObject	back to summary
public boolean containsObject(Object obj) Checks whether an object is present in the array or whether it is equal to any of the objects in the array. Parameters obj:Object The object to look for. Returns:boolean `true`, when the object could be found. `false` otherwise. See Also `Object#equals(java.lang.Object)`

public boolean containsObject(Object obj)

Checks whether an object is present in the array or whether it is equal to any of the objects in the array.

Parameters

obj:Object: The object to look for.

Returns:boolean

true, when the object could be found. false otherwise.

See Also

Object#equals(java.lang.Object)

count	back to summary
public int count() Returns the size of the array. Returns:int The number of elements that this array can store.

count

back to summary

public int count()

Returns the size of the array.

Returns:int: The number of elements that this array can store.

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

getArray	back to summary
public NSObject[] getArray() Returns the array of NSObjects represented by this NSArray. Any changes to the values of this array will also affect the NSArray. Returns:NSObject[] The actual array represented by this NSArray.

getArray

back to summary

public NSObject[] getArray()

Returns the array of NSObjects represented by this NSArray. Any changes to the values of this array will also affect the NSArray.

Returns:NSObject[]: The actual array represented by this NSArray.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

indexOfIdenticalObject back to summary

indexOfIdenticalObject	back to summary
public int indexOfIdenticalObject(Object obj) Searches for a specific object in the array. If the specified object is found (reference equality), its index is returned. Otherwise, -1 is returned. Parameters obj:Object The object to look for. Returns:int The index of the object, if it was found. -1 otherwise. See Also `indexOfObject(Object)`

public int indexOfIdenticalObject(Object obj)

Searches for a specific object in the array. If the specified object is found (reference equality), its index is returned. Otherwise, -1 is returned.

Parameters

obj:Object: The object to look for.

Returns:int

The index of the object, if it was found. -1 otherwise.

See Also

indexOfObject(Object)

indexOfObject back to summary

indexOfObject	back to summary
public int indexOfObject(Object obj) Searches for an object in the array. If the specified object or an object equal to it is found, its index is returned. Otherwise, -1 is returned. Parameters obj:Object The object to look for. Returns:int The index of the object, if it was found. -1 otherwise. See Also `Object#equals(java.lang.Object)`, `indexOfIdenticalObject(Object)`

public int indexOfObject(Object obj)

Searches for an object in the array. If the specified object or an object equal to it is found, its index is returned. Otherwise, -1 is returned.

Parameters

obj:Object: The object to look for.

Returns:int

The index of the object, if it was found. -1 otherwise.

lastObject back to summary

lastObject	back to summary
public NSObject lastObject() Returns the last object contained in this array. Equivalent to `getArray()[getArray().length-1]`. Returns:NSObject The value of the highest index in the array.

public NSObject lastObject()

Returns the last object contained in this array. Equivalent to getArray()[getArray().length-1].

Returns:NSObject: The value of the highest index in the array.

objectAtIndex back to summary

objectAtIndex	back to summary
public NSObject objectAtIndex(int i) Returns the object stored at the given index. Equivalent to `getArray()[i]`. Parameters i:int The index of the object. Returns:NSObject The object at the given index.

public NSObject objectAtIndex(int i)

Returns the object stored at the given index. Equivalent to getArray()[i].

Parameters

i:int: The index of the object.

Returns:NSObject

The object at the given index.

objectsAtIndexes	back to summary
public NSObject[] objectsAtIndexes(int... indexes) Returns a new array containing only the values stored at the given indices. The values are sorted by their index. Parameters indexes:int[] The indices of the objects. Returns:NSObject[] The new array containing the objects stored at the given indices.

objectsAtIndexes

back to summary

public NSObject[] objectsAtIndexes(int... indexes)

Returns a new array containing only the values stored at the given indices. The values are sorted by their index.

Parameters

indexes:int[]: The indices of the objects.

Returns:NSObject[]

The new array containing the objects stored at the given indices.

remove	back to summary
public void remove(int i) Removes the i-th element from the array. The array will be resized. Parameters i:int The index of the object

remove

back to summary

public void remove(int i)

Removes the i-th element from the array. The array will be resized.

Parameters

i:int: The index of the object

setValue back to summary

setValue	back to summary
public void setValue(int key, Object value) Stores an object at the specified index. If there was another object stored at that index it will be replaced. Equivalent to `getArray()[key] = value`. Parameters key:int The index where to store the object. value:Object The object.

public void setValue(int key, Object value)

Stores an object at the specified index. If there was another object stored at that index it will be replaced. Equivalent to getArray()[key] = value.

Parameters

key:int: The index where to store the object.
value:Object: The object.

toASCII	back to summary
protected void toASCII(StringBuilder ascii, int level) Implements abstract com.dd.plist.NSObject.toASCII. Doc from com.dd.plist.NSObject.toASCII. 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. Annotations @Override

toASCII

back to summary

protected void toASCII(StringBuilder ascii, int level)

Implements abstract com.dd.plist.NSObject.toASCII.

Doc from com.dd.plist.NSObject.toASCII.

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.

Annotations

@Override

toASCII	back to summary
private void toASCII(StringBuilder ascii, int level, boolean gnustep)

toASCIIGnuStep	back to summary
protected void toASCIIGnuStep(StringBuilder ascii, int level) Implements abstract com.dd.plist.NSObject.toASCIIGnuStep. Doc from com.dd.plist.NSObject.toASCIIGnuStep. Generates the ASCII representation of this object in the GnuStep format. The generated ASCII representation does not end with a newline. Annotations @Override

toASCIIGnuStep

back to summary

protected void toASCIIGnuStep(StringBuilder ascii, int level)

Implements abstract com.dd.plist.NSObject.toASCIIGnuStep.

Doc from com.dd.plist.NSObject.toASCIIGnuStep.

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

Annotations

@Override

toASCIIPropertyList	back to summary
public String toASCIIPropertyList() Generates a valid ASCII property list which has this NSArray as its root object. The generated property list complies with the format as described in Property List Programming Guide - Old-Style ASCII Property Lists. Returns:String ASCII representation of this object.

toASCIIPropertyList

back to summary

public String toASCIIPropertyList()

Generates a valid ASCII property list which has this NSArray as its root object. The generated property list complies with the format as described in Property List Programming Guide - Old-Style ASCII Property Lists.

Returns:String: ASCII representation of this object.

toBinary	back to summary
pack-priv void toBinary(BinaryPropertyListWriter out) throws IOException Implements abstract com.dd.plist.NSObject.toBinary. Doc from com.dd.plist.NSObject.toBinary. Generates the binary representation of the object. Annotations @Override 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 void toBinary(BinaryPropertyListWriter out) throws IOException

Implements abstract com.dd.plist.NSObject.toBinary.

Doc from com.dd.plist.NSObject.toBinary.

Generates the binary representation of the object.

Annotations

@Override

Exceptions

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

toGnuStepASCIIPropertyList	back to summary
public String toGnuStepASCIIPropertyList() Generates a valid ASCII property list in GnuStep format which has this NSArray as its root object. The generated property list complies with the format as described in GnuStep - NSPropertyListSerialization class documentation Returns:String GnuStep ASCII representation of this object.

toGnuStepASCIIPropertyList

back to summary

public String toGnuStepASCIIPropertyList()

Generates a valid ASCII property list in GnuStep format which has this NSArray as its root object. The generated property list complies with the format as described in GnuStep - NSPropertyListSerialization class documentation

Returns:String: GnuStep ASCII representation of this object.

toJavaObject back to summary

toJavaObject	back to summary
public Object toJavaObject() Implements abstract com.dd.plist.NSObject.toJavaObject. Doc from com.dd.plist.NSObject.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. Annotations @Override

public Object toJavaObject()

Implements abstract com.dd.plist.NSObject.toJavaObject.

Doc from com.dd.plist.NSObject.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.

Annotations

@Override

toXML	back to summary
pack-priv void toXML(StringBuilder xml, int level) Implements abstract com.dd.plist.NSObject.toXML. Doc from com.dd.plist.NSObject.toXML. Generates the XML representation of the object (without XML headers or enclosing plist-tags). Annotations @Override

toXML

back to summary

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

Implements abstract com.dd.plist.NSObject.toXML.

Doc from com.dd.plist.NSObject.toXML.

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

Annotations

@Override

public Class NSArray

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail