Java에서 사용자 정의 Iterable을 구현하는 방법

Iterable 인터페이스는 java.lang 패키지에 정의되어 있으며 Java 5 버전에서 도입되었습니다. 이 인터페이스를 구현한 객체는 "for-each" 문의 대상이 될 수 있습니다. for-each 루프는 배열과 컬렉션을 순회할 때 주로 사용되며, Iterable 인터페이스를 직접 구현하면 사용자가 원하는 커스텀 반복 동작도 만들 수 있습니다.

문법

public interface Iterable<T>

예제

아래 예제는 Person 객체들을 관리하는 PersonArrayList 클래스를 만들고, 이 클래스가 Iterable<Person> 인터페이스를 구현하여 for-each 루프로 순회할 수 있도록 한 코드입니다.

import static java.lang.String.format;
import java.util.*;

// Person 클래스
class Person {
    private String firstName, lastName;
    private int age;

    public Person() { }

    public Person(String firstName, String lastName, int age) {
        this.firstName = firstName;
        this.lastName = lastName;
        this.age = age;
    }

    public String getFirstName() {
        return firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public int getAge() {
        return age;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return format("First Name:\t%s\tLast Name:\t%s\tAge:\t%d", firstName, lastName, age);
    }
}

// PersonArrayList 클래스
public class PersonArrayList implements Iterable<Person> {
    private List<Person> persons;
    private static final int MIN_AGE = 10;

    public PersonArrayList() {
        persons = new ArrayList<Person>(MIN_AGE);
    }

    public PersonArrayList(int age) {
        persons = new ArrayList<Person>(age);
    }

    public void addPerson(Person p) {
        persons.add(p);
    }

    public void removePerson(Person p) {
        persons.remove(p);
    }

    public int age() {
        return persons.size();
    }

    @Override
    public Iterator<Person> iterator() {
        return persons.iterator();
    }

    public static void main(String[] args) {
        Person p1 = new Person("Adithya", "Sai", 20);
        Person p2 = new Person("Jai", "Dev", 30);

        PersonArrayList pList = new PersonArrayList();
        pList.addPerson(p1);
        pList.addPerson(p2);

        for (Person person : pList) {
            System.out.println(person);
        }
    }
}

코드 설명

PersonArrayList 클래스는 내부적으로 List<Person>을 사용해 데이터를 저장하며, iterator() 메서드를 오버라이드하여 내부 리스트의 반복자를 반환합니다. 이렇게 하면 별도의 복잡한 처리 없이 for-each 문으로 컬렉션의 모든 요소를 손쉽게 순회할 수 있습니다.

출력 결과

First Name:   Adithya   Last Name:   Sai   Age:   20
First Name:   Jai       Last Name:   Dev   Age:   30