Array (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.lang.reflect
class Array

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

Method Summary
`static native Object`	`get(Object array, int index)` Returns the value of the indexed component in the specified array object.
`static native boolean`	`getBoolean(Object array, int index)` Returns the value of the indexed component in the specified array object, as a `boolean`.
`static native byte`	`getByte(Object array, int index)` Returns the value of the indexed component in the specified array object, as a `byte`.
`static native char`	`getChar(Object array, int index)` Returns the value of the indexed component in the specified array object, as a `char`.
`static native double`	`getDouble(Object array, int index)` Returns the value of the indexed component in the specified array object, as a `double`.
`static native float`	`getFloat(Object array, int index)` Returns the value of the indexed component in the specified array object, as a `float`.
`static native int`	`getInt(Object array, int index)` Returns the value of the indexed component in the specified array object, as an `int`.
`static native int`	`getLength(Object array)` Returns the length of the specified array object, as an `int`.
`static native long`	`getLong(Object array, int index)` Returns the value of the indexed component in the specified array object, as a `long`.
`static native short`	`getShort(Object array, int index)` Returns the value of the indexed component in the specified array object, as a `short`.
`static Object`	`newInstance(Class componentType, int length)` Creates a new array with the specified component type and length.
`static Object`	`newInstance(Class componentType, int[] dimensions)` Creates a new array with the specified component type and dimensions.
`static native void`	`set(Object array, int index, Object value)` Sets the value of the indexed component of the specified array object to the specified new value.
`static native void`	`setBoolean(Object array, int index, boolean z)` Sets the value of the indexed component of the specified array object to the specified `boolean` value.
`static native void`	`setByte(Object array, int index, byte b)` Sets the value of the indexed component of the specified array object to the specified `byte` value.
`static native void`	`setChar(Object array, int index, char c)` Sets the value of the indexed component of the specified array object to the specified `char` value.
`static native void`	`setDouble(Object array, int index, double d)` Sets the value of the indexed component of the specified array object to the specified `double` value.
`static native void`	`setFloat(Object array, int index, float f)` Sets the value of the indexed component of the specified array object to the specified `float` value.
`static native void`	`setInt(Object array, int index, int i)` Sets the value of the indexed component of the specified array object to the specified `int` value.
`static native void`	`setLong(Object array, int index, long l)` Sets the value of the indexed component of the specified array object to the specified `long` value.
`static native void`	`setShort(Object array, int index, short s)` Sets the value of the indexed component of the specified array object to the specified `short` value.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

get

public static native Object get(Object array,
                                int index)
                         throws IllegalArgumentException,
                                ArrayIndexOutOfBoundsException

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.

Parameters:: array - the array; index - the index
Returns:: the (possibly wrapped) value of the indexed component in the specified array
Throws:: IllegalArgumentException - If the specified object is not an array; ArrayIndexOutOfBoundsException - If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

getBoolean

public static native boolean getBoolean(Object array,
                                        int index)
                                 throws IllegalArgumentException,
                                        ArrayIndexOutOfBoundsException

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

Parameters:: array - the array; index - the index
Returns:: the value of the indexed component in the specified array
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; ArrayIndexOutOfBoundsException - If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

getByte

public static native byte getByte(Object array,
                                  int index)
                           throws IllegalArgumentException,
                                  ArrayIndexOutOfBoundsException

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

Parameters:: array - the array; index - the index
Returns:: the value of the indexed component in the specified array
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; ArrayIndexOutOfBoundsException - If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

getChar

public static native char getChar(Object array,
                                  int index)
                           throws IllegalArgumentException,
                                  ArrayIndexOutOfBoundsException

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

Parameters:: array - the array; index - the index
Returns:: the value of the indexed component in the specified array
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; ArrayIndexOutOfBoundsException - If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

getDouble

public static native double getDouble(Object array,
                                      int index)
                               throws IllegalArgumentException,
                                      ArrayIndexOutOfBoundsException

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

Parameters:: array - the array; index - the index
Returns:: the value of the indexed component in the specified array
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; ArrayIndexOutOfBoundsException - If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

getFloat

public static native float getFloat(Object array,
                                    int index)
                             throws IllegalArgumentException,
                                    ArrayIndexOutOfBoundsException

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

Parameters:: array - the array; index - the index
Returns:: the value of the indexed component in the specified array
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; ArrayIndexOutOfBoundsException - If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

getInt

public static native int getInt(Object array,
                                int index)
                         throws IllegalArgumentException,
                                ArrayIndexOutOfBoundsException

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

Parameters:: array - the array; index - the index
Returns:: the value of the indexed component in the specified array
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; ArrayIndexOutOfBoundsException - If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

getLength

public static native int getLength(Object array)
                            throws IllegalArgumentException

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

Parameters:: array - the array
Returns:: the length of the array
Throws:: IllegalArgumentException - if the object argument is not an array

getLong

public static native long getLong(Object array,
                                  int index)
                           throws IllegalArgumentException,
                                  ArrayIndexOutOfBoundsException

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

Parameters:: array - the array; index - the index
Returns:: the value of the indexed component in the specified array
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; ArrayIndexOutOfBoundsException - If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

getShort

public static native short getShort(Object array,
                                    int index)
                             throws IllegalArgumentException,
                                    ArrayIndexOutOfBoundsException

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

Parameters:: array - the array; index - the index
Returns:: the value of the indexed component in the specified array
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; ArrayIndexOutOfBoundsException - If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

newInstance

public static Object newInstance(Class componentType,
                                 int length)
                          throws NegativeArraySizeException

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

Parameters:: componentType - the Class object representing the component type of the new array; length - the length of the new array
Returns:: the new array
Throws:: NegativeArraySizeException - if the specified length is negative

newInstance

public static Object newInstance(Class componentType,
                                 int[] dimensions)
                          throws IllegalArgumentException,
                                 NegativeArraySizeException

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

Parameters:: componentType - the Class object representing the component type of the new array; dimensions - an array of int representing the dimensions of the new array
Returns:: the new array
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 {@link Void#TYPE}.; NegativeArraySizeException - if any of the components in the specified dimensions argument is negative.

set

public static native void set(Object array,
                              int index,
                              Object value)
                       throws IllegalArgumentException,
                              ArrayIndexOutOfBoundsException

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.

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

setBoolean

public static native void setBoolean(Object array,
                                     int index,
                                     boolean z)
                              throws IllegalArgumentException,
                                     ArrayIndexOutOfBoundsException

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

Parameters:: array - the array; index - the index into the array; z - the new value of the indexed component
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; ArrayIndexOutOfBoundsException - If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

setByte

public static native void setByte(Object array,
                                  int index,
                                  byte b)
                           throws IllegalArgumentException,
                                  ArrayIndexOutOfBoundsException

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

Parameters:: array - the array; index - the index into the array; b - the new value of the indexed component
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; ArrayIndexOutOfBoundsException - If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

setChar

public static native void setChar(Object array,
                                  int index,
                                  char c)
                           throws IllegalArgumentException,
                                  ArrayIndexOutOfBoundsException

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

Parameters:: array - the array; index - the index into the array; c - the new value of the indexed component
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; ArrayIndexOutOfBoundsException - If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

setDouble

public static native void setDouble(Object array,
                                    int index,
                                    double d)
                             throws IllegalArgumentException,
                                    ArrayIndexOutOfBoundsException

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

Parameters:: array - the array; index - the index into the array; d - the new value of the indexed component
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; ArrayIndexOutOfBoundsException - If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

setFloat

public static native void setFloat(Object array,
                                   int index,
                                   float f)
                            throws IllegalArgumentException,
                                   ArrayIndexOutOfBoundsException

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

Parameters:: array - the array; index - the index into the array; f - the new value of the indexed component
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; ArrayIndexOutOfBoundsException - If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

setInt

public static native void setInt(Object array,
                                 int index,
                                 int i)
                          throws IllegalArgumentException,
                                 ArrayIndexOutOfBoundsException

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

Parameters:: array - the array; index - the index into the array; i - the new value of the indexed component
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; ArrayIndexOutOfBoundsException - If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

setLong

public static native void setLong(Object array,
                                  int index,
                                  long l)
                           throws IllegalArgumentException,
                                  ArrayIndexOutOfBoundsException

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

Parameters:: array - the array; index - the index into the array; l - the new value of the indexed component
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; ArrayIndexOutOfBoundsException - If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

setShort

public static native void setShort(Object array,
                                   int index,
                                   short s)
                            throws IllegalArgumentException,
                                   ArrayIndexOutOfBoundsException

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

Parameters:: array - the array; index - the index into the array; s - the new value of the indexed component
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; ArrayIndexOutOfBoundsException - If the specified index argument is negative, or if it is greater than or equal to the length of the specified array

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:

The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.

java.lang.reflectclass Array

get

getBoolean

getByte

getChar

getDouble

getFloat

getInt

getLength

getLong

getShort

newInstance

newInstance

set

setBoolean

setByte

setChar

setDouble

setFloat

setInt

setLong

setShort

java.lang.reflect
class Array