java.lang.reflect.Array

Array

Java SE 6

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.

Methods

public static Object

get(Object array, int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

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.

array	the array
index	the index
return	the (possibly wrapped) value of the indexed component in the specified array
Throws	NullPointerException: If the specified object is null
Throws	IllegalArgumentException: If the specified object is not an array
Throws	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 Object

newInstance(Class componentType, int length) throws NegativeArraySizeException Details

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);

componentType	the `Class` object representing the component type of the new array
length	the length of the new array
return	the new array
Throws	NullPointerException: if the specified `componentType` parameter is null
Throws	IllegalArgumentException: if componentType is `Void#TYPE`
Throws	NegativeArraySizeException: if the specified `length` is negative

public static Object

newInstance(Class componentType, int[] dimensions) throws IllegalArgumentException, NegativeArraySizeException Details

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).

componentType the Class object representing the component type of the new array

dimensions an array of int representing the dimensions of the new array

return the new array

Throws NullPointerException: if the specified componentType argument is null

Throws 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.

Throws NegativeArraySizeException: if any of the components in the specified dimensions argument is negative.

public static void

set(Object array, int index, Object value) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

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.

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

Properties

public static void

setBoolean(Object array, int index, boolean z) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

Sets the value of the indexed component of the specified array object to the specified boolean value.

array	the array
index	the index into the array
z	the new value of the indexed component
Throws	NullPointerException: If the specified object argument is null
Throws	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
Throws	ArrayIndexOutOfBoundsException: If the specified `index` argument is negative, or if it is greater than or equal to the length of the specified array
See also	set

public static boolean

getBoolean(Object array, int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

Returns the value of the indexed component in the specified array object, as a boolean.

array	the array
index	the index
return	the value of the indexed component in the specified array
Throws	NullPointerException: If the specified object is null
Throws	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
Throws	ArrayIndexOutOfBoundsException: If the specified `index` argument is negative, or if it is greater than or equal to the length of the specified array
See also	get

public static void

setByte(Object array, int index, byte b) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

Sets the value of the indexed component of the specified array object to the specified byte value.

array	the array
index	the index into the array
b	the new value of the indexed component
Throws	NullPointerException: If the specified object argument is null
Throws	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
Throws	ArrayIndexOutOfBoundsException: If the specified `index` argument is negative, or if it is greater than or equal to the length of the specified array
See also	set

public static byte

getByte(Object array, int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

Returns the value of the indexed component in the specified array object, as a byte.

array	the array
index	the index
return	the value of the indexed component in the specified array
Throws	NullPointerException: If the specified object is null
Throws	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
Throws	ArrayIndexOutOfBoundsException: If the specified `index` argument is negative, or if it is greater than or equal to the length of the specified array
See also	get

public static void

setChar(Object array, int index, char c) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

Sets the value of the indexed component of the specified array object to the specified char value.

array	the array
index	the index into the array
c	the new value of the indexed component
Throws	NullPointerException: If the specified object argument is null
Throws	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
Throws	ArrayIndexOutOfBoundsException: If the specified `index` argument is negative, or if it is greater than or equal to the length of the specified array
See also	set

public static char

getChar(Object array, int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

Returns the value of the indexed component in the specified array object, as a char.

array	the array
index	the index
return	the value of the indexed component in the specified array
Throws	NullPointerException: If the specified object is null
Throws	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
Throws	ArrayIndexOutOfBoundsException: If the specified `index` argument is negative, or if it is greater than or equal to the length of the specified array
See also	get

public static void

setDouble(Object array, int index, double d) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

Sets the value of the indexed component of the specified array object to the specified double value.

array	the array
index	the index into the array
d	the new value of the indexed component
Throws	NullPointerException: If the specified object argument is null
Throws	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
Throws	ArrayIndexOutOfBoundsException: If the specified `index` argument is negative, or if it is greater than or equal to the length of the specified array
See also	set

public static double

getDouble(Object array, int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

Returns the value of the indexed component in the specified array object, as a double.

array	the array
index	the index
return	the value of the indexed component in the specified array
Throws	NullPointerException: If the specified object is null
Throws	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
Throws	ArrayIndexOutOfBoundsException: If the specified `index` argument is negative, or if it is greater than or equal to the length of the specified array
See also	get

public static void

setFloat(Object array, int index, float f) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

Sets the value of the indexed component of the specified array object to the specified float value.

array	the array
index	the index into the array
f	the new value of the indexed component
Throws	NullPointerException: If the specified object argument is null
Throws	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
Throws	ArrayIndexOutOfBoundsException: If the specified `index` argument is negative, or if it is greater than or equal to the length of the specified array
See also	set

public static float

getFloat(Object array, int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

Returns the value of the indexed component in the specified array object, as a float.

array	the array
index	the index
return	the value of the indexed component in the specified array
Throws	NullPointerException: If the specified object is null
Throws	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
Throws	ArrayIndexOutOfBoundsException: If the specified `index` argument is negative, or if it is greater than or equal to the length of the specified array
See also	get

public static void

setInt(Object array, int index, int i) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

Sets the value of the indexed component of the specified array object to the specified int value.

array	the array
index	the index into the array
i	the new value of the indexed component
Throws	NullPointerException: If the specified object argument is null
Throws	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
Throws	ArrayIndexOutOfBoundsException: If the specified `index` argument is negative, or if it is greater than or equal to the length of the specified array
See also	set

public static int

getInt(Object array, int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

Returns the value of the indexed component in the specified array object, as an int.

array	the array
index	the index
return	the value of the indexed component in the specified array
Throws	NullPointerException: If the specified object is null
Throws	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
Throws	ArrayIndexOutOfBoundsException: If the specified `index` argument is negative, or if it is greater than or equal to the length of the specified array
See also	get

public static int

getLength(Object array) throws IllegalArgumentException Details

Returns the length of the specified array object, as an int.

array	the array
return	the length of the array
Throws	IllegalArgumentException: if the object argument is not an array

public static void

setLong(Object array, int index, long l) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

Sets the value of the indexed component of the specified array object to the specified long value.

array	the array
index	the index into the array
l	the new value of the indexed component
Throws	NullPointerException: If the specified object argument is null
Throws	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
Throws	ArrayIndexOutOfBoundsException: If the specified `index` argument is negative, or if it is greater than or equal to the length of the specified array
See also	set

public static long

getLong(Object array, int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

Returns the value of the indexed component in the specified array object, as a long.

array	the array
index	the index
return	the value of the indexed component in the specified array
Throws	NullPointerException: If the specified object is null
Throws	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
Throws	ArrayIndexOutOfBoundsException: If the specified `index` argument is negative, or if it is greater than or equal to the length of the specified array
See also	get

public static void

setShort(Object array, int index, short s) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

Sets the value of the indexed component of the specified array object to the specified short value.

array	the array
index	the index into the array
s	the new value of the indexed component
Throws	NullPointerException: If the specified object argument is null
Throws	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
Throws	ArrayIndexOutOfBoundsException: If the specified `index` argument is negative, or if it is greater than or equal to the length of the specified array
See also	set

public static short

getShort(Object array, int index) throws IllegalArgumentException, ArrayIndexOutOfBoundsException Details

Returns the value of the indexed component in the specified array object, as a short.

array	the array
index	the index
return	the value of the indexed component in the specified array
Throws	NullPointerException: If the specified object is null
Throws	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
Throws	ArrayIndexOutOfBoundsException: If the specified `index` argument is negative, or if it is greater than or equal to the length of the specified array
See also	get

About DocWeb · Bundles · Export · Export All

Top 10 · Statistics · Login

About Sun · Contact · Privacy · Terms of Use · Trademarks

Java SE 6