Skip to main content

Section 14.3 Worked Example: Writing ArrayLists - Shifting Values

Subgoals for Writing ArrayLists.

  1. Importing the ArrayList class
    1. Before using ArrayList, import it from the java.util package:
      import java.util.ArrayList;
  2. Declaring an ArrayList variable
    1. Determine the type of objects to be stored (use wrapper classes for primitives, e.g., Integer instead of int)
    2. Determine the name of the ArrayList variable
    3. Use syntax: ArrayList<DataType> name;
  3. Instantiating an ArrayList object
    1. Use the new keyword with the constructor to create a new ArrayList object (When ArrayLists are instantiated, they are empty and have a size of 0.)
  4. Adding elements to an ArrayList
    1. To add to the end of an ArrayList, use: listName.add(valueToBeAdded)
    2. To add an element at a specific location in an ArrayList, use: listName.add(index, valueToBeAdded) where index is within the bounds 0 to listName.size()
  5. Accessing an element in an ArrayList
    1. Determine the index of the element to be accessed
    2. Use: listName.get(index) to retrieve the element
    3. Ensure the index is within bounds: 0 to listName.size() - 1, otherwise an IndexOutOfBoundsException occurs
  6. Changing a value in an ArrayList
    1. Determine the index of the element to be changed
    2. Determine the new value or expression to assign
    3. Use: listName.set(index, newValue) to update the value
    4. Ensure the index is within bounds: 0 to listName.size() - 1, otherwise an IndexOutOfBoundsException occurs
  7. Traversing an ArrayList
    1. Decide whether accessing all elements, updating, or accessing a subset
    2. If only accessing elements, use an enhanced for (for-each) loop:
      1. for (DataType item : listName) - iterates from first to last, storing a copy of each element in item
    3. If updating or using indices, use a traditional for loop:
      1. Initialize loop control variable to 0 (or listName.size() - 1 for reverse)
      2. Set condition: i < listName.size() (or i >= 0 for reverse)
      3. Increment or decrement loop control variable appropriately
    4. Use Subgoals 5 or 6 to access or change values as appropriate
  8. Whole list actions
    1. Passing an ArrayList as an argument
      1. Check if the method expects an ArrayList argument (check documentation or method signature)
      2. When calling a method, pass a reference to an ArrayList (usually variable name) as an argument in the method call.
      3. Note: changes to elements in the ArrayList that are done inside the method will persist

Subsection 14.3.1

Problem: Write the Java code that will store integer values in decreasing order. Values may be added at any time.

Subsection 14.3.2 SG1: Importing the ArrayList class and SG2: Declaring an ArrayList variable and SG3: Instantiating an ArrayList object

Because we don’t know how many values will be stored, we need to use an ArrayList of integers. We will name the variable decreasing.
import java.util.ArrayList;
ArrayList<Integer> decreasing = new ArrayList<Integer>();

Subsection 14.3.3 SG4: Adding elements to an ArrayList

Suppose we know in advance the first four values to be added. We can write the code to place them exactly where they belong in the ArrayList:
decreasing.add(50);			// [ 50 ]
decreasing.add(1, 25);		// [ 50, 25 ]
decreasing.add(0, 100);		// [ 100, 50, 25 ]
decreasing.add(2, 32);		// [ 100, 50, 32, 25 ]
At this point, run this code in the Active Code block at the bottom of the page to see the shifting and inserting happening.
Recall that in Section 12.3, we had to do a lot of work to shift values of an array. The ArrayList has this shifting functionality built in, so when we insert at the beginning of a non-empty ArrayList, all the elements shift over and when we insert in the middle, all the elements after the inserted element shift over. We do not have to write the code to shift the elements inside the array list.

Subsection 14.3.4 Expanding the Code

Now we want to let the user enter additional values, and our logic will insert the values into the correct place in the ArrayList.
The purpose of the loop is to continue reading values until the user enters a value signifying that they are done. This special value is sometimes called a sentinel. For this example, a user will enter the value -1000 to signify the end of the input. So the termination condition of the loop is when the input is -1000. We invert that to become the continuation condition (while input != -1000). The other important part of this loop is the initialization of variables - we need to read the first value to be inserted before the loop and then update the value (read again) at the bottom of the loop:
import java.util.Scanner;
System.out.println("Enter values to be inserted, -1000 to end"); 
Scanner scan = new Scanner(System.in);
int value = scan.nextInt();
while (value != -1000) {
    int insertAtIndex = 0;
    while(insertAtIndex < decreasing.size() && decreasing.get(insertAtIndex) > value) {
        insertAtIndex++;
    }
    decreasing.add(insertAtIndex, value);

    System.out.println("Enter values to be inserted, -1000 to end"); 
    value = scan.nextInt();
}

Subsection 14.3.5 Practice Pages

You have attempted 1 of 2 activities on this page.