JavaSystem.Arraycopy(Object, Int32, Object, Int32, Int32) Method

Definition

Copies an array from the specified source array, beginning at the specified position, to the specified position of the destination array.

[Android.Runtime.Register("arraycopy", "(Ljava/lang/Object;ILjava/lang/Object;II)V", "")]
public static void Arraycopy (Java.Lang.Object src, int srcPos, Java.Lang.Object dest, int destPos, int length);
[<Android.Runtime.Register("arraycopy", "(Ljava/lang/Object;ILjava/lang/Object;II)V", "")>]
static member Arraycopy : Java.Lang.Object * int * Java.Lang.Object * int * int -> unit

Parameters

src
Object

the source array.

srcPos
Int32

starting position in the source array.

dest
Object

the destination array.

destPos
Int32

starting position in the destination data.

length
Int32

the number of array elements to be copied.

Attributes

Remarks

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 dest. The number of components copied is equal to the length argument. The components at positions srcPos through srcPos+length-1 in the source array are copied into positions destPos through destPos+length-1, respectively, of the destination array.

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

If dest is null, then a NullPointerException is thrown.

If src is null, then a NullPointerException is thrown and the destination array is not modified.

Otherwise, if any of the following is true, an ArrayStoreException is thrown and the destination is not modified: <ul> <li>The src argument refers to an object that is not an array. <li>The dest argument refers to an object that is not an array. <li>The src argument and dest argument refer to arrays whose component types are different primitive types. <li>The src argument refers to an array with a primitive component type and the dest argument refers to an array with a reference component type. <li>The src argument refers to an array with a reference component type and the dest argument refers to an array with a primitive component type. </ul>

Otherwise, if any of the following is true, an IndexOutOfBoundsException is thrown and the destination is not modified: <ul> <li>The srcPos argument is negative. <li>The destPos argument is negative. <li>The length argument is negative. <li>srcPos+length is greater than src.length, the length of the source array. <li>destPos+length is greater than dest.length, the length of the destination array. </ul>

Otherwise, if any actual component of the source array from position srcPos through srcPos+length-1 cannot be converted to the component type of the destination array by assignment conversion, an ArrayStoreException is thrown. In this case, let <b>k</b> be the smallest nonnegative integer less than length such that src[srcPos+k] cannot be converted to the component type of the destination array; when the exception is thrown, source array components from positions srcPos through srcPos+k-1 will already have been copied to destination array positions destPos through destPos+k-1 and no other positions of the destination array will have been modified. (Because of the restrictions already itemized, this paragraph effectively applies only to the situation where both arrays have component types that are reference types.)

Java documentation for java.lang.System.arraycopy(java.lang.Object, int, java.lang.Object, int, int).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to