Докладний аналіз класу ArrayList [Частина 2]

На жаль, в одну статтю вся інформація не помістилася, тому продовжуємо розбиратися з методами класу ArrayList, що залишабося. Відсортувати колекцію:

public void sort(Comparator< ? super E> c)

Здійснює сортування списку за заданим правилом. Правило сортування є реалізований інтерфейс Comparator з перевизначеним методом compare(). Перевизначення потрібне, якщо колекція містить об'єкти власного класу. При роботі зі стандартними класами (Integer, String тощо) перевизначення compare зазвичай потрібне лише для нестандартного сортування. Створимо клас Student:

class Student{
 String student_name;
 int id;

 Student(int id, String  student_name){
  this.id = id;
  this.student_name = student_name;
 }

 public String toString(){
  return id + " " + student_name;
 }
}

Напишемо простий компаратор, який порівнюватиме id студентів:

class StudentIdComparator implements Comparator<student>{

 public int compare(Student e1, Student e2) {
  return e1.id.compareTo(e2.id);
 }
}

Створимо список для студентів та об'єкт класу, що реалізує Comparator:

ArrayList<Student> myList = new ArrayList<> ();
StudentIdComparator comparator = new StudentIdComparator();

Викличемо метод sortдля нашого списку і передамо компаратор:

myList.sort(comparator);

В результаті вихідний список [4 David, 2 Tom, 5 Rohit, 1 Paul, 3 Vishal] перетвориться на [1 Paul, 2 Tom, 3 Vishal, 4 David, 5 Rohit]. Насамкінець я залишив дуже цікавий, але рідко ким використовуваний метод:

public List<E> subList(int fromIndex, int toIndex)

Він повертає не новий список, як може здатися, а вид списку (підсписок), для якого цей метод був викликаний, таким чином, що обидва списки будуть розділяти елементи, що зберігаються. subList - повнофункціональний список, він працює і на запис, вносячи відповідні зміни до батьківського списку. З цього випливають чудові властивості:

someList.subList(3, 7).clear();

У цьому прикладі зі списку someListбуде видалено чотири елементи, з третього по сьомий (не включно). Вказуємо діапазон для роботи зі списком та вперед. Усередині методу по суті відбувається звернення до класу SubList, у якого є власні реалізації відомих методів, а в результаті роботи методу повертається об'єкт цього класу. Саму реалізацію класу можна переглянути у вихідному коді . Для закріплення матеріалу пропоную Вам написати свою реалізацію динамічного масиву. Це буде дуже корисно у майбутньому. Як приклад, я представляю свою реалізацію динамічного масиву тільки для чисел з коментарями в коді.

public class IntegerArrayList {

    private int [] elements;  //массив, для хранения чисел
    private int size;  //поле-счетчик, которое указывает на количество элементов в массиве
    private static final int DEFAULT_CAPACITY = 10;  //размер массива по умолчанию

    //конструктор без параметров, который создает массив на 10 элементов, если размер не был указан
    public IntegerArrayList(){  //
        this.elements = new int[DEFAULT_CAPACITY];
    }

    //создает массив указанной емкости
    public IntegerArrayList(int initialCapacity){
        if (initialCapacity >= 0){
            this.elements = new int[initialCapacity];
        }
        else {
            throw new IllegalStateException("Capacity can't be less than 0!");
        }
    }

    //получает элемент по указанному индексу
    public int get(int index){
        isIndexExist(index);  //проверка корректности введенного индекса
        return elements[index];
    }

    //возвращает количество элементов в списке
    public int size (){
        return size;
    }

    //добавляем элемент в конец списка
    public boolean add(int value){
        if (size == elements.length){  //если в массиве места нет
            elements = increaseCapacity(); //вызываем метод, который отвечает за увеличение массива
        }
        elements[size] = value; //записываем в конец списка новое значення
        size++;  //увеличиваем значення переменной размера списка
        return true;
    }

    //дополнительный закрытый метод для увеличения емкости массива
    private int [] increaseCapacity(){
        int [] temp = new int[(elements.length * 2)];  //создаем новый массив большего размера
        System.arraycopy(elements, 0, temp, 0, elements.length);  //копируем в новый массив элементы из старого массива
        return temp;
    }

    //устанавливает элемент на указанную позицию
    public int set(int value, int index){
        isIndexExist(index);
        int temp = elements[index];
        elements[index] = value;
        return temp;
    }

    //переопределил метод для красивого вывода списка на экран, иначе будут выводиться значения незаполненных ячеек [1, 10] замість [1, 10, 0, 0...]
    @Override
    public String toString(){
        int [] temp = new int[size];
        System.arraycopy(elements, 0, temp, 0, size);
        return Arrays.toString(temp);
    }

    //проверяем индексы, не выходят ли они за границы массива
    private int isIndexExist(int index){
        if (index >= size || index < 0){
            throw new IndexOutOfBoundsException("Element can't be found! "
                    + "Number of elements in array = " + size
                    + ". Total size of array = " + elements.length);
        }
        return index;
    }

    //проверяем, есть ли элементы в списке
    public boolean isEmpty(){
        return (size == 0);
    }

    //удаляем элемент по индексу
    public int remove (int index){
        isIndexExist(index);  //проверяем индекс
        int [] temp = elements;  //во временный массив заносим ссылку на текущий массив
        elements = new int [temp.length-1];  //полю elements присваиваем ссылку на новый массив размером меньше на 1
        int value = temp[index];  //сохраняем в доп. переменную значення удаляемого елемента
        System.arraycopy(temp, 0, elements, 0, index);  //копируем левую часть массива до указанного индекса
        System.arraycopy(temp, index + 1, elements, index, temp.length - index - 1);  //копируем правую часть массива после указанного индекса
        size--;  //уменьшаем значення переменной
        return value;
    }
}

Список використаних джерел:

1. Вихідний код ArrayList (актуальність – JDK 12);
2. Більшість ілюстрацій брав звідси і деякі статті з JavaRush;
3. Стаття на хабрі .