Class Array
java.lang.Object
java.lang.reflect.Array
The
Array class provides static methods to dynamically create andaccess Java arrays.Array permits widening conversions to occur during a get or setoperation, but throws anIllegalArgumentException if a narrowingconversion would occur.
- Since:
- 1.1
Method Summary
Modifier and TypeMethodDescriptionstaticObjectReturns the value of the indexed component in the specifiedarray object.static booleangetBoolean(Object array, int index) Returns the value of the indexed component in the specifiedarray object, as aboolean.static byteReturns the value of the indexed component in the specifiedarray object, as abyte.static charReturns the value of the indexed component in the specifiedarray object, as achar.static doubleReturns the value of the indexed component in the specifiedarray object, as adouble.static floatReturns the value of the indexed component in the specifiedarray object, as afloat.static intReturns the value of the indexed component in the specifiedarray object, as anint.static intReturns the length of the specified array object, as anint.static longReturns the value of the indexed component in the specifiedarray object, as along.static shortReturns the value of the indexed component in the specifiedarray object, as ashort.staticObjectnewInstance(Class<?> componentType, int length) Creates a new array with the specified component type andlength.staticObjectnewInstance(Class<?> componentType, int... dimensions) Creates a new arraywith the specified component type and dimensions.static voidSets the value of the indexed component of the specified arrayobject to the specified new value.static voidsetBoolean(Object array, int index, boolean z) Sets the value of the indexed component of the specified arrayobject to the specifiedbooleanvalue.static voidSets the value of the indexed component of the specified arrayobject to the specifiedbytevalue.static voidSets the value of the indexed component of the specified arrayobject to the specifiedcharvalue.static voidSets the value of the indexed component of the specified arrayobject to the specifieddoublevalue.static voidSets the value of the indexed component of the specified arrayobject to the specifiedfloatvalue.static voidSets the value of the indexed component of the specified arrayobject to the specifiedintvalue.static voidSets the value of the indexed component of the specified arrayobject to the specifiedlongvalue.static voidSets the value of the indexed component of the specified arrayobject to the specifiedshortvalue.
Method Details
newInstance
public static Object newInstance(Class<?> componentType, int length) throwsNegativeArraySizeException Creates a new array with the specified component type andlength.- Implementation Requirements:
- Invoking this method is equivalent to creating an arrayas follows:
Array.newInstance(componentType, new int[]{length});The number of dimensions of the new array must notexceed 255.
- Parameters:
componentType- theClassobject representing the component type of the new arraylength- the length of the new array- Returns:
- the new array
- Throws:
NullPointerException- if the specifiedcomponentTypeparameter is nullIllegalArgumentException- if componentType isVoid.TYPEor if the number of dimensions of the requested array instance exceed 255.NegativeArraySizeException- if the specifiedlengthis negative
newInstance
public static Object newInstance(Class<?> componentType, int... dimensions) throwsIllegalArgumentException,NegativeArraySizeException Creates a new arraywith the specified component type and dimensions.IfcomponentTyperepresents a non-array class or interface, the new arrayhasdimensions.lengthdimensions andcomponentTypeas its component type. IfcomponentTyperepresents an array class, thenumber of dimensions of the new array is equal to the sumofdimensions.lengthand the number ofdimensions ofcomponentType. In this case, thecomponent type of the new array is the component type ofcomponentType.The number of dimensions of the new array must notexceed 255.
- Parameters:
componentType- theClassobject representing the componenttype of the new arraydimensions- an array ofintrepresenting the dimensions ofthe new array- Returns:
- the new array
- Throws:
NullPointerException- if the specifiedcomponentTypeargument is nullIllegalArgumentException- if the specifieddimensionsargument is a zero-dimensional array, if componentType isVoid.TYPE, or if the number of dimensions of the requested arrayinstance exceed 255.NegativeArraySizeException- if any of the components inthe specifieddimensionsargument is negative.
getLength
Returns the length of the specified array object, as anint.- Parameters:
array- the array- Returns:
- the length of the array
- Throws:
IllegalArgumentException- if the object argument is notan array
get
public static Object get(Object array, int index) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Returns the value of the indexed component in the specifiedarray object. The value is automatically wrapped in an objectif it has a primitive type.- Parameters:
array- the arrayindex- the index- Returns:
- the (possibly wrapped) value of the indexed component inthe specified array
- Throws:
NullPointerException- If the specified object is nullIllegalArgumentException- If the specified object is notan arrayArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal to thelength of the specified array
getBoolean
public static boolean getBoolean(Object array, int index) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Returns the value of the indexed component in the specifiedarray object, as aboolean.- Parameters:
array- the arrayindex- the index- Returns:
- the value of the indexed component in the specified array
- Throws:
NullPointerException- If the specified object is nullIllegalArgumentException- If the specified object is notan array, or if the indexed element cannot be converted to thereturn type by an identity or widening conversionArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal to thelength of the specified array- See Also:
getByte
public static byte getByte(Object array, int index) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Returns the value of the indexed component in the specifiedarray object, as abyte.- Parameters:
array- the arrayindex- the index- Returns:
- the value of the indexed component in the specified array
- Throws:
NullPointerException- If the specified object is nullIllegalArgumentException- If the specified object is notan array, or if the indexed element cannot be converted to thereturn type by an identity or widening conversionArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal to thelength of the specified array- See Also:
getChar
public static char getChar(Object array, int index) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Returns the value of the indexed component in the specifiedarray object, as achar.- Parameters:
array- the arrayindex- the index- Returns:
- the value of the indexed component in the specified array
- Throws:
NullPointerException- If the specified object is nullIllegalArgumentException- If the specified object is notan array, or if the indexed element cannot be converted to thereturn type by an identity or widening conversionArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal to thelength of the specified array- See Also:
getShort
public static short getShort(Object array, int index) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Returns the value of the indexed component in the specifiedarray object, as ashort.- Parameters:
array- the arrayindex- the index- Returns:
- the value of the indexed component in the specified array
- Throws:
NullPointerException- If the specified object is nullIllegalArgumentException- If the specified object is notan array, or if the indexed element cannot be converted to thereturn type by an identity or widening conversionArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal to thelength of the specified array- See Also:
getInt
public static int getInt(Object array, int index) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Returns the value of the indexed component in the specifiedarray object, as anint.- Parameters:
array- the arrayindex- the index- Returns:
- the value of the indexed component in the specified array
- Throws:
NullPointerException- If the specified object is nullIllegalArgumentException- If the specified object is notan array, or if the indexed element cannot be converted to thereturn type by an identity or widening conversionArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal to thelength of the specified array- See Also:
getLong
public static long getLong(Object array, int index) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Returns the value of the indexed component in the specifiedarray object, as along.- Parameters:
array- the arrayindex- the index- Returns:
- the value of the indexed component in the specified array
- Throws:
NullPointerException- If the specified object is nullIllegalArgumentException- If the specified object is notan array, or if the indexed element cannot be converted to thereturn type by an identity or widening conversionArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal to thelength of the specified array- See Also:
getFloat
public static float getFloat(Object array, int index) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Returns the value of the indexed component in the specifiedarray object, as afloat.- Parameters:
array- the arrayindex- the index- Returns:
- the value of the indexed component in the specified array
- Throws:
NullPointerException- If the specified object is nullIllegalArgumentException- If the specified object is notan array, or if the indexed element cannot be converted to thereturn type by an identity or widening conversionArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal to thelength of the specified array- See Also:
getDouble
public static double getDouble(Object array, int index) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Returns the value of the indexed component in the specifiedarray object, as adouble.- Parameters:
array- the arrayindex- the index- Returns:
- the value of the indexed component in the specified array
- Throws:
NullPointerException- If the specified object is nullIllegalArgumentException- If the specified object is notan array, or if the indexed element cannot be converted to thereturn type by an identity or widening conversionArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal to thelength of the specified array- See Also:
set
public static void set(Object array, int index,Object value) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Sets the value of the indexed component of the specified arrayobject to the specified new value. The new value is firstautomatically unwrapped if the array has a primitive componenttype.- Parameters:
array- the arrayindex- the index into the arrayvalue- the new value of the indexed component- Throws:
NullPointerException- If the specified object argumentis nullIllegalArgumentException- If the specified object argumentis not an array, or if the array component type is primitive andan unwrapping conversion failsArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal tothe length of the specified array
setBoolean
public static void setBoolean(Object array, int index, boolean z) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Sets the value of the indexed component of the specified arrayobject to the specifiedbooleanvalue.- Parameters:
array- the arrayindex- the index into the arrayz- the new value of the indexed component- Throws:
NullPointerException- If the specified object argumentis nullIllegalArgumentException- If the specified object argumentis not an array, or if the specified value cannot be convertedto the underlying array's component type by an identity or aprimitive widening conversionArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal tothe length of the specified array- See Also:
setByte
public static void setByte(Object array, int index, byte b) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Sets the value of the indexed component of the specified arrayobject to the specifiedbytevalue.- Parameters:
array- the arrayindex- the index into the arrayb- the new value of the indexed component- Throws:
NullPointerException- If the specified object argumentis nullIllegalArgumentException- If the specified object argumentis not an array, or if the specified value cannot be convertedto the underlying array's component type by an identity or aprimitive widening conversionArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal tothe length of the specified array- See Also:
setChar
public static void setChar(Object array, int index, char c) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Sets the value of the indexed component of the specified arrayobject to the specifiedcharvalue.- Parameters:
array- the arrayindex- the index into the arrayc- the new value of the indexed component- Throws:
NullPointerException- If the specified object argumentis nullIllegalArgumentException- If the specified object argumentis not an array, or if the specified value cannot be convertedto the underlying array's component type by an identity or aprimitive widening conversionArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal tothe length of the specified array- See Also:
setShort
public static void setShort(Object array, int index, short s) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Sets the value of the indexed component of the specified arrayobject to the specifiedshortvalue.- Parameters:
array- the arrayindex- the index into the arrays- the new value of the indexed component- Throws:
NullPointerException- If the specified object argumentis nullIllegalArgumentException- If the specified object argumentis not an array, or if the specified value cannot be convertedto the underlying array's component type by an identity or aprimitive widening conversionArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal tothe length of the specified array- See Also:
setInt
public static void setInt(Object array, int index, int i) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Sets the value of the indexed component of the specified arrayobject to the specifiedintvalue.- Parameters:
array- the arrayindex- the index into the arrayi- the new value of the indexed component- Throws:
NullPointerException- If the specified object argumentis nullIllegalArgumentException- If the specified object argumentis not an array, or if the specified value cannot be convertedto the underlying array's component type by an identity or aprimitive widening conversionArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal tothe length of the specified array- See Also:
setLong
public static void setLong(Object array, int index, long l) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Sets the value of the indexed component of the specified arrayobject to the specifiedlongvalue.- Parameters:
array- the arrayindex- the index into the arrayl- the new value of the indexed component- Throws:
NullPointerException- If the specified object argumentis nullIllegalArgumentException- If the specified object argumentis not an array, or if the specified value cannot be convertedto the underlying array's component type by an identity or aprimitive widening conversionArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal tothe length of the specified array- See Also:
setFloat
public static void setFloat(Object array, int index, float f) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Sets the value of the indexed component of the specified arrayobject to the specifiedfloatvalue.- Parameters:
array- the arrayindex- the index into the arrayf- the new value of the indexed component- Throws:
NullPointerException- If the specified object argumentis nullIllegalArgumentException- If the specified object argumentis not an array, or if the specified value cannot be convertedto the underlying array's component type by an identity or aprimitive widening conversionArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal tothe length of the specified array- See Also:
setDouble
public static void setDouble(Object array, int index, double d) throwsIllegalArgumentException,ArrayIndexOutOfBoundsException Sets the value of the indexed component of the specified arrayobject to the specifieddoublevalue.- Parameters:
array- the arrayindex- the index into the arrayd- the new value of the indexed component- Throws:
NullPointerException- If the specified object argumentis nullIllegalArgumentException- If the specified object argumentis not an array, or if the specified value cannot be convertedto the underlying array's component type by an identity or aprimitive widening conversionArrayIndexOutOfBoundsException- If the specifiedindexargument is negative, or if it is greater than or equal tothe length of the specified array- See Also: