目次

列挙型

列挙型(しばしば列挙またはenumと呼ばれる)は、一定数の定数値を表すために使用される特殊な種類のクラスです。

単純な列挙型の宣言

#

単純な列挙型を宣言するには、enumキーワードを使用して、列挙する値をリストします。

dart
enum Color { red, green, blue }

拡張列挙型の宣言

#

Dartでは、列挙型の宣言で、フィールド、メソッド、および一定数の既知の定数インスタンスに制限されたconstコンストラクタを持つクラスを宣言することもできます。

拡張列挙型を宣言するには、通常のクラスと同様の構文を使用しますが、いくつかの追加の要件があります。

  • インスタンス変数は、mixinによって追加されたものも含めて、finalでなければなりません。
  • すべての生成コンストラクタは定数でなければなりません。
  • ファクトリコンストラクタは、一定数の既知の列挙型インスタンスのいずれかしか返すことができません。
  • Enum は自動的に拡張されるため、他のクラスを拡張することはできません。
  • indexhashCode、等値演算子==をオーバーライドすることはできません。
  • 自動生成される静的valuesゲッターと競合するため、valuesという名前のメンバーを列挙型で宣言することはできません。
  • 列挙型のすべてのインスタンスは宣言の先頭に宣言する必要があり、少なくとも1つのインスタンスを宣言する必要があります。

拡張列挙型のインスタンスメソッドでは、thisを使用して現在の列挙型値を参照できます。

複数のインスタンス、インスタンス変数、ゲッター、および実装されたインターフェースを持つ拡張列挙型を宣言する例を以下に示します。

dart
enum Vehicle implements Comparable<Vehicle> {
  car(tires: 4, passengers: 5, carbonPerKilometer: 400),
  bus(tires: 6, passengers: 50, carbonPerKilometer: 800),
  bicycle(tires: 2, passengers: 1, carbonPerKilometer: 0);

  const Vehicle({
    required this.tires,
    required this.passengers,
    required this.carbonPerKilometer,
  });

  final int tires;
  final int passengers;
  final int carbonPerKilometer;

  int get carbonFootprint => (carbonPerKilometer / passengers).round();

  bool get isTwoWheeled => this == Vehicle.bicycle;

  @override
  int compareTo(Vehicle other) => carbonFootprint - other.carbonFootprint;
}

列挙型の使い方

#

列挙値には、他の静的変数と同様にアクセスします。

dart
final favoriteColor = Color.blue;
if (favoriteColor == Color.blue) {
  print('Your favorite color is blue!');
}

列挙型の各値にはindexゲッターがあり、列挙型宣言における値の0ベースの位置を返します。たとえば、最初の値のインデックスは0、2番目の値のインデックスは1です。

dart
assert(Color.red.index == 0);
assert(Color.green.index == 1);
assert(Color.blue.index == 2);

すべての列挙値のリストを取得するには、列挙型のvalues定数を使用します。

dart
List<Color> colors = Color.values;
assert(colors[2] == Color.blue);

switch文で列挙型を使用でき、すべての列挙値を処理していない場合は警告が表示されます。

dart
var aColor = Color.blue;

switch (aColor) {
  case Color.red:
    print('Red as roses!');
  case Color.green:
    print('Green as grass!');
  default: // Without this, you see a WARNING.
    print(aColor); // 'Color.blue'
}

Color.blueから'blue'など、列挙値の名前へのアクセスが必要な場合は、.nameプロパティを使用します。

dart
print(Color.blue.name); // 'blue'

通常のオブジェクトと同様に、列挙値のメンバーにアクセスできます。

dart
print(Vehicle.car.carbonFootprint);