Name

splice()

Description

Inserts a value or an array of values into an existing array. The first two parameters must be arrays of the same datatype. The first parameter specifies the initial array to be modified, and the second parameter defines the data to be inserted. The third parameter is an index value which specifies the array position from which to insert data. (Remember that array index numbering starts at zero, so the first position is 0, the second position is 1, and so on.)

When splicing an array of objects, the data returned from the function must be cast to the object array's data type. For example: SomeClass[] items = (SomeClass[]) splice(array1, array2, index)

Examples

  • String[] a = { "OH", "NY", "CA" };
    a = splice(a, "KY", 1);  // Splice one value into an array
    println(a);
    // Prints the following array contents to the console:
    // [0] "OH"
    // [1] "KY"
    // [2] "NY"
    // [3] "CA"
    
    println();  // Prints a blank line
    
    String[] b = { "VA", "CO", "IL" };
    a = splice(a, b, 2);  // Splice one array of values into another
    println(a);
    // Prints the following array contents to the console:
    // [0] "OH"
    // [1] "KY"
    // [2] "VA"
    // [3] "CO"
    // [4] "IL"
    // [5] "NY"
    // [6] "CA"
    

Syntax

  • splice(list, value, index)

Parameters

  • list(boolean[], byte[], char[], int[], float[], String[], Object)array to splice into
  • value(boolean, boolean[], byte, byte[], char, char[], int, int[], float, float[], String, String[], Object)value to be spliced in
  • index(int)position in the array from which to insert data

Return

  • boolean[], byte[], char[], int[], float[], String[], or Object