Interface Comparable

Parte da seção Programação Orientada a Objetos do Journey de Dart da Coddy — lição 72 de 110.

Enquanto == diz se dois objetos são iguais, às vezes você precisa saber qual vem primeiro. A interface Comparable permite que seus objetos sejam ordenados definindo uma ordenação natural.

Para tornar uma classe comparável, implemente Comparable<T> e sobrescreva o método compareTo. Este método retorna um número negativo se this vier antes de other, zero se forem iguais e um número positivo se this vier depois:

class Student implements Comparable<Student> {
  String name;
  int grade;
  
  Student(this.name, this.grade);
  
  @override
  int compareTo(Student other) {
    return grade.compareTo(other.grade);
  }
}

void main() {
  var students = [
    Student('Alice', 85),
    Student('Bob', 92),
    Student('Carol', 78),
  ];
  
  students.sort();
  
  for (var s in students) {
    print('${s.name}: ${s.grade}');
  }
  // Carol: 78, Alice: 85, Bob: 92
}

Uma vez que sua classe implemente Comparable, você pode usar sort() sem fornecer um comparador personalizado. Os tipos numéricos e de string integrados já implementam Comparable, e é por isso que grade.compareTo(other.grade) funciona diretamente.

Para ordem decrescente, basta inverter a comparação trocando os objetos ou negando o resultado:

@override
int compareTo(Student other) {
  return other.grade.compareTo(grade);  // Decrescente
}

Desafio

Fácil

Vamos construir um sistema de gerenciamento de tarefas onde as tarefas podem ser ordenadas pelo seu nível de prioridade! Você criará uma classe Task que implementa a interface Comparable, permitindo que uma lista de tarefas seja automaticamente ordenada da maior para a menor prioridade.

Você organizará seu código em dois arquivos:

task.dart: Crie uma classe Task que representa um item a fazer com um name (String) e priority (int, onde números maiores significam maior prioridade). Sua tarefa deve implementar Comparable<Task> para que, quando ordenada, as tarefas apareçam em ordem decrescente por prioridade (maior prioridade primeiro). Também sobrescreva toString() para retornar o formato: [name] (Priority: [priority])
main.dart: Importe seu arquivo de tarefa e demonstre como a interface Comparable permite a ordenação automática. Crie uma lista contendo estas quatro tarefas:
- 'Write report' com prioridade 2
- 'Fix critical bug' com prioridade 5
- 'Update documentation' com prioridade 1
- 'Review code' com prioridade 3
Imprima Before sorting:, depois imprima cada tarefa. Ordene a lista usando sort(), imprima uma linha vazia, depois imprima After sorting: seguido por cada tarefa novamente.

Como sua classe Task implementa Comparable, você pode chamar sort() diretamente na lista sem fornecer um comparador personalizado. As tarefas se organizarão automaticamente com base na sua implementação de compareTo!

Saída esperada:

Before sorting:
Write report (Priority: 2)
Fix critical bug (Priority: 5)
Update documentation (Priority: 1)
Review code (Priority: 3)

After sorting:
Fix critical bug (Priority: 5)
Review code (Priority: 3)
Write report (Priority: 2)
Update documentation (Priority: 1)

Folha de consulta

A interface Comparable permite que objetos definam uma ordenação natural para classificação. Implemente Comparable<T> e sobrescreva o método compareTo.

O método compareTo retorna:

Um número negativo se this vier antes de other
Zero se forem iguais
Um número positivo se this vier depois de other

Implementação básica (ordem crescente):

class Student implements Comparable<Student> {
  String name;
  int grade;
  
  Student(this.name, this.grade);
  
  @override
  int compareTo(Student other) {
    return grade.compareTo(other.grade);
  }
}

Uma vez que uma classe implementa Comparable, você pode usar sort() sem um comparador personalizado:

var students = [
  Student('Alice', 85),
  Student('Bob', 92),
  Student('Carol', 78),
];

students.sort();  // Automatically uses compareTo

Para ordem decrescente, inverta a comparação:

@override
int compareTo(Student other) {
  return other.grade.compareTo(grade);  // Descending
}

Experimente você mesmo

import 'task.dart';

void main() {
  // TODO: Criar uma lista de objetos Task com o seguinte:
  // - 'Write report' com prioridade 2
  // - 'Fix critical bug' com prioridade 5
  // - 'Update documentation' com prioridade 1
  // - 'Review code' com prioridade 3
  
  List<Task> tasks = [
    // TODO: Adicionar as quatro tarefas aqui
  ];
  
  // TODO: Imprimir "Before sorting:"
  // TODO: Imprimir cada tarefa da lista
  
  // TODO: Ordenar a lista usando sort()
  
  // TODO: Imprimir uma linha vazia
  
  // TODO: Imprimir "After sorting:"
  // TODO: Imprimir cada tarefa da lista ordenada
}