System.arraycopy

Class Overview | Class Members | This Package | All Packages

Syntax

public static native void arraycopy( Object src, int src_position, Object dst, int dst_position, int length )

Parameters

src:: the source array.
srcpos: start position in the source array.
dest: the destination array.
destpos: start position in the destination data.
length: the number of array elements to be copied.

Description

Copies an array from the specified source array, beginning at the specified position, to the specified position of the destination array. A subsequence of array components are copied from the source array referenced by src to the destination array referenced by dst. The number of components copied is equal to the length argument. The components at positions srcOffset through srcOffset+length-1 in the source array are copied into positions dstOffset through dstOffset+length-1, respectively, of the destination array.

If the src and dst arguments refer to the same array object, then the copying is performed as if the components at positions srcOffset through srcOffset+length-1 were first copied to a temporary array with length components and then the contents of the temporary array were copied into positions dstOffset through dstOffset+length-1 of the argument array.

If any of the following is true, an ArrayStoreException is thrown and the destination is not modified:

The src argument refers to an object that is not an array.
The dst argument refers to an object that is not an array.
The src argument and dst argument refer to arrays whose component types are different primitive types.
The src argument refers to an array with a primitive component type and the dst argument refers to an array with a reference component type.
The src argument refers to an array with a reference component type and the dst argument refers to an array with a primitive component type.

Otherwise, if any of the following is true, an ArrayIndexOutOfBoundsException is thrown and the destination is not modified:

The srcOffset argument is negative.
The dstOffset argument is negative.
The length argument is negative.
srcOffset+length is greater than src.length, the length of the source array.
dstOffset+length is greater than dst.length, the length of the destination array.

Otherwise, if any actual component of the source array from position srcOffset through srcOffset+length-1 cannot be converted to the component type of the destination array by assignment conversion, an ArrayStoreException is thrown. In this case, let k be the smallest nonnegative integer less than length such that src[srcOffset+k] cannot be converted to the component type of the destination array; when the exception is thrown, source array components from positions srcOffset through srcOffset+k-1 will already have been copied to destination array positions dstOffset through dstOffset+k-1 and no other positions of the destination array will have been modified.

Exceptions

ArrayIndexOutOfBoundsException if copying would cause access of data outside array bounds.

Exceptions

ArrayStoreException if an element in the src array could not be stored into the dest array because of a type mismatch.