FileDocCategorySizeDatePackage
Array.javaAPI DocJava SE 5 API20786Fri Aug 26 14:57:06 BST 2005java.lang.reflect

Array

public final class Array extends Object
The Array class provides static methods to dynamically create and access Java arrays.

Array permits widening conversions to occur during a get or set operation, but throws an IllegalArgumentException if a narrowing conversion would occur.

author
Nakul Saraiya

Fields Summary
Constructors Summary
private Array()
Constructor. Class Array is not instantiable.

Methods Summary
public static native java.lang.Objectget(java.lang.Object array, int index)
Returns the value of the indexed component in the specified array object. The value is automatically wrapped in an object if it has a primitive type.

param
array the array
param
index the index
return
the (possibly wrapped) value of the indexed component in the specified array
exception
NullPointerException If the specified object is null
exception
IllegalArgumentException If the specified object is not an array
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

public static native booleangetBoolean(java.lang.Object array, int index)
Returns the value of the indexed component in the specified array object, as a boolean.

param
array the array
param
index the index
return
the value of the indexed component in the specified array
exception
NullPointerException If the specified object is null
exception
IllegalArgumentException If the specified object is not an array, or if the indexed element cannot be converted to the return type by an identity or widening conversion
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array
see
Array#get

public static native bytegetByte(java.lang.Object array, int index)
Returns the value of the indexed component in the specified array object, as a byte.

param
array the array
param
index the index
return
the value of the indexed component in the specified array
exception
NullPointerException If the specified object is null
exception
IllegalArgumentException If the specified object is not an array, or if the indexed element cannot be converted to the return type by an identity or widening conversion
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array
see
Array#get

public static native chargetChar(java.lang.Object array, int index)
Returns the value of the indexed component in the specified array object, as a char.

param
array the array
param
index the index
return
the value of the indexed component in the specified array
exception
NullPointerException If the specified object is null
exception
IllegalArgumentException If the specified object is not an array, or if the indexed element cannot be converted to the return type by an identity or widening conversion
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array
see
Array#get

public static native doublegetDouble(java.lang.Object array, int index)
Returns the value of the indexed component in the specified array object, as a double.

param
array the array
param
index the index
return
the value of the indexed component in the specified array
exception
NullPointerException If the specified object is null
exception
IllegalArgumentException If the specified object is not an array, or if the indexed element cannot be converted to the return type by an identity or widening conversion
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array
see
Array#get

public static native floatgetFloat(java.lang.Object array, int index)
Returns the value of the indexed component in the specified array object, as a float.

param
array the array
param
index the index
return
the value of the indexed component in the specified array
exception
NullPointerException If the specified object is null
exception
IllegalArgumentException If the specified object is not an array, or if the indexed element cannot be converted to the return type by an identity or widening conversion
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array
see
Array#get

public static native intgetInt(java.lang.Object array, int index)
Returns the value of the indexed component in the specified array object, as an int.

param
array the array
param
index the index
return
the value of the indexed component in the specified array
exception
NullPointerException If the specified object is null
exception
IllegalArgumentException If the specified object is not an array, or if the indexed element cannot be converted to the return type by an identity or widening conversion
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array
see
Array#get

public static native intgetLength(java.lang.Object array)
Returns the length of the specified array object, as an int.

param
array the array
return
the length of the array
exception
IllegalArgumentException if the object argument is not an array

public static native longgetLong(java.lang.Object array, int index)
Returns the value of the indexed component in the specified array object, as a long.

param
array the array
param
index the index
return
the value of the indexed component in the specified array
exception
NullPointerException If the specified object is null
exception
IllegalArgumentException If the specified object is not an array, or if the indexed element cannot be converted to the return type by an identity or widening conversion
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array
see
Array#get

public static native shortgetShort(java.lang.Object array, int index)
Returns the value of the indexed component in the specified array object, as a short.

param
array the array
param
index the index
return
the value of the indexed component in the specified array
exception
NullPointerException If the specified object is null
exception
IllegalArgumentException If the specified object is not an array, or if the indexed element cannot be converted to the return type by an identity or widening conversion
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array
see
Array#get

private static native java.lang.ObjectmultiNewArray(java.lang.Class componentType, int[] dimensions)

private static native java.lang.ObjectnewArray(java.lang.Class componentType, int length)

public static java.lang.ObjectnewInstance(java.lang.Class componentType, int length)
Creates a new array with the specified component type and length. Invoking this method is equivalent to creating an array as follows:
int[] x = {length};
Array.newInstance(componentType, x);

param
componentType the Class object representing the component type of the new array
param
length the length of the new array
return
the new array
exception
NullPointerException if the specified componentType parameter is null
exception
IllegalArgumentException if componentType is Void.TYPE
exception
NegativeArraySizeException if the specified length is negative

	return newArray(componentType, length);
    
public static java.lang.ObjectnewInstance(java.lang.Class componentType, int[] dimensions)
Creates a new array with the specified component type and dimensions. If componentType represents a non-array class or interface, the new array has dimensions.length dimensions and  componentType  as its component type. If componentType represents an array class, the number of dimensions of the new array is equal to the sum of dimensions.length and the number of dimensions of componentType. In this case, the component type of the new array is the component type of componentType.

The number of dimensions of the new array must not exceed the number of array dimensions supported by the implementation (typically 255).

param
componentType the Class object representing the component type of the new array
param
dimensions an array of int types representing the dimensions of the new array
return
the new array
exception
NullPointerException if the specified componentType argument is null
exception
IllegalArgumentException if the specified dimensions argument is a zero-dimensional array, or if the number of requested dimensions exceeds the limit on the number of array dimensions supported by the implementation (typically 255), or if componentType is Void.TYPE.
exception
NegativeArraySizeException if any of the components in the specified dimensions argument is negative.

	return multiNewArray(componentType, dimensions);
    
public static native voidset(java.lang.Object array, int index, java.lang.Object value)
Sets the value of the indexed component of the specified array object to the specified new value. The new value is first automatically unwrapped if the array has a primitive component type.

param
array the array
param
index the index into the array
param
value the new value of the indexed component
exception
NullPointerException If the specified object argument is null
exception
IllegalArgumentException If the specified object argument is not an array, or if the array component type is primitive and an unwrapping conversion fails
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

public static native voidsetBoolean(java.lang.Object array, int index, boolean z)
Sets the value of the indexed component of the specified array object to the specified boolean value.

param
array the array
param
index the index into the array
param
z the new value of the indexed component
exception
NullPointerException If the specified object argument is null
exception
IllegalArgumentException If the specified object argument is not an array, or if the specified value cannot be converted to the underlying array's component type by an identity or a primitive widening conversion
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array
see
Array#set

public static native voidsetByte(java.lang.Object array, int index, byte b)
Sets the value of the indexed component of the specified array object to the specified byte value.

param
array the array
param
index the index into the array
param
b the new value of the indexed component
exception
NullPointerException If the specified object argument is null
exception
IllegalArgumentException If the specified object argument is not an array, or if the specified value cannot be converted to the underlying array's component type by an identity or a primitive widening conversion
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array
see
Array#set

public static native voidsetChar(java.lang.Object array, int index, char c)
Sets the value of the indexed component of the specified array object to the specified char value.

param
array the array
param
index the index into the array
param
c the new value of the indexed component
exception
NullPointerException If the specified object argument is null
exception
IllegalArgumentException If the specified object argument is not an array, or if the specified value cannot be converted to the underlying array's component type by an identity or a primitive widening conversion
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array
see
Array#set

public static native voidsetDouble(java.lang.Object array, int index, double d)
Sets the value of the indexed component of the specified array object to the specified double value.

param
array the array
param
index the index into the array
param
d the new value of the indexed component
exception
NullPointerException If the specified object argument is null
exception
IllegalArgumentException If the specified object argument is not an array, or if the specified value cannot be converted to the underlying array's component type by an identity or a primitive widening conversion
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array
see
Array#set

public static native voidsetFloat(java.lang.Object array, int index, float f)
Sets the value of the indexed component of the specified array object to the specified float value.

param
array the array
param
index the index into the array
param
f the new value of the indexed component
exception
NullPointerException If the specified object argument is null
exception
IllegalArgumentException If the specified object argument is not an array, or if the specified value cannot be converted to the underlying array's component type by an identity or a primitive widening conversion
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array
see
Array#set

public static native voidsetInt(java.lang.Object array, int index, int i)
Sets the value of the indexed component of the specified array object to the specified int value.

param
array the array
param
index the index into the array
param
i the new value of the indexed component
exception
NullPointerException If the specified object argument is null
exception
IllegalArgumentException If the specified object argument is not an array, or if the specified value cannot be converted to the underlying array's component type by an identity or a primitive widening conversion
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array
see
Array#set

public static native voidsetLong(java.lang.Object array, int index, long l)
Sets the value of the indexed component of the specified array object to the specified long value.

param
array the array
param
index the index into the array
param
l the new value of the indexed component
exception
NullPointerException If the specified object argument is null
exception
IllegalArgumentException If the specified object argument is not an array, or if the specified value cannot be converted to the underlying array's component type by an identity or a primitive widening conversion
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array
see
Array#set

public static native voidsetShort(java.lang.Object array, int index, short s)
Sets the value of the indexed component of the specified array object to the specified short value.

param
array the array
param
index the index into the array
param
s the new value of the indexed component
exception
NullPointerException If the specified object argument is null
exception
IllegalArgumentException If the specified object argument is not an array, or if the specified value cannot be converted to the underlying array's component type by an identity or a primitive widening conversion
exception
ArrayIndexOutOfBoundsException If the specified index argument is negative, or if it is greater than or equal to the length of the specified array
see
Array#set