아이템 14. Comparable을 구현할지 고려하라

`compareTo` 메서드란 ?

Comparable 인터페이스의 일부로 제공되며, 객체들을 서로 비교할 수 있게 해주는 기능을 제공
equals 메서드와 비교하여 compareTo는 단순 동치성 비교에 더해 순서까지 비교할 수 있으며, 제네릭함.
Object 클래스의 메서드가 아님

compareTo의 특징과 필요성

순서 비교 기능
- compareTo 메서드는 객체들의 순서를 비교할 수 있어, 객체를 정렬하거나 최대/최소 값을 찾는 데 사용될 수 있음
- EX. 배열을 정렬할 때 Arrays.sort() 메서드가 내부적으로 객체의 compareTo를 사용
제네릭 지원
- Comparable 인터페이스는 제네릭을 지원하여, 동일한 타입의 객체들만 비교하도록 강제함.
```
public interface Comparable<T> {
  int compareTo(T t);
}
```
자바 플랫폼과의 통합
- 많은 자바 표준 라이브러리 클래스들(예: String, BigDecimal)과 모든 열거 타입은 Comparable 인터페이스를 구현하여 자연스러운 순서를 가집니다.
- 알파벳, 숫자, 연대 같이 순서가 명확한 값 클래스를 작성한다면 반드시 Comparable 인터페이스를 구현하자.
- Comparable을 구현하면 검색, 극단값 계산, 자동 정렬되는 컬렉션 관리도 쉽게 할 수 있음

compareTo 메서드 구현 예시

EX. PhoneNumber 클래스에 Comparable 인터페이스를 구현

전화번호를 지역 코드, 프리픽스, 줄 번호 순으로 비교

public class PhoneNumber implements Comparable<PhoneNumber> {
    private int areaCode;
    private int prefix;
    private int lineNumber;

    public PhoneNumber(int areaCode, int prefix, int lineNumber) {
        this.areaCode = areaCode;
        this.prefix = prefix;
        this.lineNumber = lineNumber;
    }

    @Override
    public int compareTo(PhoneNumber other) {
        int result = Integer.compare(this.areaCode, other.areaCode);
        if (result == 0) {
            result = Integer.compare(this.prefix, other.prefix);
            if (result == 0) {
                result = Integer.compare(this.lineNumber, other.lineNumber);
            }
        }
        return result;
    }

    @Override
    public String toString() {
        return String.format("%d-%d-%d", areaCode, prefix, lineNumber);
    }
}

사용 예

이 클래스의 인스턴스를 TreeSet에 추가하면 자동으로 전화번호 순으로 정렬됨

public static void main(String[] args) {
    Set<PhoneNumber> phoneNumbers = new TreeSet<>();
    phoneNumbers.add(new PhoneNumber(408, 555, 1234));
    phoneNumbers.add(new PhoneNumber(408, 555, 4321));
    phoneNumbers.add(new PhoneNumber(209, 555, 1234));

    for (PhoneNumber pn : phoneNumbers) {
        System.out.println(pn);
    }
}

출력 결과
```
209-555-1234
408-555-1234
408-555-4321
```

compareTo 메서드의 일반 규약

equals의 규약과 비슷하지만 다른 점 존재!
- 모든 객체에 대해 전역 동치관계를 부여하는 equals 메서드와 달리, compareTo는 타입이 다른 객체를 신경 쓰지 않아도 됨=> 타입이 다른 객체가 주어지면 간단히 ClassCastException을 던져도 됨
- 일반 규약에서는 다른 타입 사이의 비교도 허용하는데, 보통은 비교한 객체들이 구현한 공통 인터페이스를 매개로 이뤄짐
hashCode 규약을 지키지 못하면 해시를 사용하는 클래스와 어울리지 못하듯, compareTo 규약을 지키지 못하면 비교를 활용하는 클래스와 어울리지 못함
- 비교를 활용하는 클래스
  - 정적인 컬렉션 TreeSet, TreeMap
  - 검색과 정렬 알고리즘을 활용하는 유틸리티 클래스 Collections와 Arrays
아래 세 규약은 compareTo 메서드로 수행하는 동치성 검사도 equals 규약과 똑같이 반사성, 대칭성, 추이성을 충족해야 함을 뜻함 (equals와 주의사항, 우회법도 똑같음)
1. Comparable을 구현한 클래스는 모든 x, y에 대해 sgn(x.compareTo(y)) == -sgn(y.compareTo(x))여야 한다(따라서 x.compareTo(y)는 y.compareTo(x)가 예외를 던질때에 한해 예외를 던져야 함
  
  = 두 객체 참조의 순서를 바꿔 비교해도 예상한 결과가 나와야 함
2. Comparable을 구현한 클래스는 추이성을 보장해야 한다. 즉, (x.compareTo(y) > 0 && y.compareTo(z) > 0)이면 x.compareTo(z) > 0이다.
3. Comparable을 구현한 클래스는 모든 z에 대해 x.compareTo(y) == 0이면 sgn(x.compareTo(z)) == sgn(y.compareTo(z))다.
  
  = 크기가 같은 객체들끼리는 어떤 객체와 비교하더라도 항상 같아야 함
필수는 아니지만 꼭 지키길 권하는 규약
- (x.compareTo(y) == 0) == (x.equals(y))여야 한다. Comparable을 구현하고 이 권고를 지키지 않는 모든 클래스는 그 사실을 명시해야 한다. 다음과 같이 명시하면 적당할 것이다. "주의: 이 클래스의 순서는 equals 메서드와 일관되지 않다."
⇒ compareTo 메서드로 수행한 동치성 테스트의 결과가 equals와 같아야 한다는 것
- 이를 잘 지키면 compareTo로 줄지은 순서 = equals의 결과

*compareTo 메서드란 ?*

compareTo의 특징과 필요성

compareTo 메서드 구현 예시

compareTo 메서드의 일반 규약

compareTo 메서드 작성 요령

`compareTo` 메서드란 ?