10.7    Die Spezial-Oberklasse Enum 

Jeder Aufzählungstyp erbt von der Spezialklasse Enum. Nehmen wir erneut die Wochentage:[ 204 ](Mit java.time.DayOfWeek deklariert die Java SE einen Aufzählungstyp für Wochentage inklusive Methoden, der in Produktivsoftware bevorzugt werden sollte. Wir bilden ihn nach, weil er so anschaulich ist. )

Listing 10.35    src/main/java/com/tutego/insel/enums/Weekday.java, Ausschnitt

public enum Weekday {

  MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

}

Der Compiler übersetzt dies in eine Aufzählungsklasse, die etwa so aussieht:

public class Weekday extends Enum {



  public static final Weekday MONDAY  = new Weekday( "MONDAY",   0 );

  public static final Weekday TUESDAY = new Weekday( "TUESDAY ", 1 );

  // weitere Konstanten ...



  private Weekday( String s, int i ) {

    super( s, i );

  }



  // weitere Methoden ...

}

 

10.7.1    Methoden auf Enum-Objekten 

Jedes Aufzählungselement ist ein Objekt und besitzt automatisch einige Standardmethoden, die von der Oberklasse java.lang.Enum kommen. Das sind zum einen überschriebene Methoden aus java.lang.Object, einige neue Objektmethoden und einige statische Methoden (siehe Abbildung 10.9).

Abbildung 10.9    Typbeziehung von »Enum«

String-Repräsentation

Den Namen der Konstanten liefert die Methode name(). Dazu gesellt sich die bekannte toString()-Methode, die standardmäßig name() aufruft, aber überschrieben werden kann. Die Methode name() lässt sich nicht überschreiben.

Die vom Compiler generierte Aufzählungsklasse bietet eine statische valueOf(String)-Methode, die das Aufzählungselement liefert, das zur name()-Repräsentation passt. Wird bei valueOf(String) ein String übergeben, zu dem es kein Aufzählungselement gibt, folgt eine IllegalArgumentException. Dazu kommt eine weitere statische Methode Enum.valueOf(Class<T> enumType, String name), die aus der Oberklasse Enum stammt.

System.out.println( Weekday.MONDAY.toString() );                       // MONDAY

System.out.println( Weekday.MONDAY.name() );                           // MONDAY

System.out.println( Weekday.valueOf( "MONDAY" ).name() );              // MONDAY

System.out.println( Enum.valueOf( Weekday.class, "MONDAY" ).name() );  // MONDAY

Der Unterschied zu den valueOf(…)-Methoden ist wichtig: Während es Enum.valueOf(Class, String) nur einmal gibt, existieren statische valueOf(String)-Methoden einmal in jeder vom Compiler generierten Aufzählungsklasse. Da die Methode also compilergeneriert ist, taucht sie in der folgenden Aufzählung nicht auf:

abstract class java.lang.Enum<E extends Enum<E>>

implements Comparable<E>, Serializable

• final String name()
  
  Liefert den Namen der Konstanten. Da die Methode – wie viele andere der Klasse – final ist, lässt sich der Name nicht ändern.

• String toString()
  
  Liefert den Namen der Konstanten. Die Methode ruft standardisiert name() auf, weil sie aber nicht final ist, kann sie überschrieben werden.

• static <T extends Enum<T>> T valueOf(Class<T> enumType, String s)
  
  Ermöglicht das Suchen von Enum-Objekten zu einem Konstantennamen und einer Enum-Klasse. Sie liefert das Enum-Objekt für die gegebene Zeichenfolge oder löst eine IllegalArgumentException aus, wenn dem String kein Enum-Objekt zuzuordnen ist.

Alle Konstanten der Klasse aufzählen

Eine praktische statische Methode ist values(). Sie liefert ein Array von allen Aufzählungen vom Aufzählungstyp. Nützlich ist das für das erweiterte for, das alle Konstanten aufzählen soll. Eine Alternative mit dem gleichen Ergebnis ist die Class-Methode getEnumConstants():

Listing 10.36    src/main/java/com/tutego/insel/enums/WeekdayDemo.java, Ausschnitt

for ( Weekday day : Weekday.values() )  // oder Weekday.class.getEnumConstants()

  System.out.println( "Name=" + day.name() );

Liefert Zeilen mit Name=MONDAY …

Ordinalzahl

Von der Oberklasse Enum erbt jede Aufzählung einen geschützten parametrisierten Konstruktor, der den Namen der Konstanten sowie einen assoziierten Zähler erwartet. So wird aus jedem Element der Aufzählung ein Objekt vom Basistyp Enum, das einen Namen und eine ID, die sogenannte Ordinalzahl, speichert. Natürlich kann es auch nach seinem Namen und Zähler gefragt werden.

static int getOrdinal( String name ) {

  try {

    return Weekday.valueOf( name ).ordinal();

  }

  catch ( IllegalArgumentException e ) {

    return -1;

  }

}

Die Ordinalzahl gibt die Position in der Deklaration an und ist auch Ordnungskriterium der compareTo(…)-Methode. Die Ordinalzahl lässt sich nicht ändern und repräsentiert immer die Reihenfolge der deklarierten Konstanten.

System.out.println( Weekday.MONDAY.compareTo( Weekday.FRIDAY ) );   // -4

System.out.println( Weekday.MONDAY.compareTo( Weekday.MONDAY ) );   //  0

System.out.println( Weekday.FRIDAY.compareTo( Weekday.MONDAY) );    //  4

abstract class java.lang.Enum<E extends Enum<E>>

implements Comparable<E>, Serializable

• final int ordinal()
  
  Liefert die zur Konstanten gehörige ID. Im Allgemeinen ist diese Ordinalzahl nicht wichtig, aber besondere Datenstrukturen wie EnumSet oder EnumMap nutzen diese eindeutige ID. Die Reihenfolge der Zahlen ist durch die Reihenfolge der Angabe gegeben.

• final boolean equals(Object other)
  
  Die Oberklasse Enum überschreibt equals(…) mit der Logik wie in Object – also den Vergleich der Referenzen –, um sie als final zu markieren.

• protected final Object clone() throws CloneNotSupportedException
  
  Die Methode clone() ist final protected und kann also weder überschrieben noch von außen aufgerufen werden. So kann es keine Kopien der Enum-Objekte geben, die die Identität gefährden könnten. Grundsätzlich ist es aber erlaubt, dass eigene Implementierungen von clone() die this-Referenz liefern.

• final int compareTo(E o)
  
  Da die Enum-Klasse die Schnittstelle Comparable implementiert, gibt es auch die Methode compareTo(…). Sie vergleicht anhand der Ordinalzahlen. Vergleiche sind nur innerhalb eines Enum-Typs erlaubt.

• final Class<E> getDeclaringClass()
  
  Liefert das Class-Objekt von der Aufzählungsklasse zu einem konkreten Enum. Achtung: Die Methode liefert, auf der Aufzählungsklasse selbst angewendet, null. Nur auf den Elementen der Aufzählung liefert sie einen sinnvollen Wert. So wäre Weekday.class.getDeclaringClass() gleich null, aber Weekday.MONDAY.getDeclaringClass() wie gewünscht com.tutego.weekday.Weekday.

 

10.7.2    Aufzählungen mit eigenen Methoden und Initialisierern * 

Da ein enum-Typ eine besondere Form der Klassendeklaration ist, kann er ebenso Attribute, Methoden, statische bzw. Objekt-Initialisierer und Konstruktoren deklarieren. Jede Aufzählung hat automatisch Methoden wie name() und ordinal(), und Entwickler können auch eigene hinzufügen.

Country mit zusätzlicher Klassenmethode

Ein Aufzählungstyp kann statische Methoden besitzen. Diese Methoden können auf statische Eigenschaften des Aufzählungstyps zugreifen und zum Beispiel Konstanten auswählen. values() ist so eine gegebene statische Methode, die ein Array aller Aufzählungselemente liefert.

public enum Country {

  GERMANY, UK, CHINA;

  public static Country getDefault() { return GERMANY; }

  public static Country random() { return values()[ (int)(Math.random()*3 ) ]; }

}

Zusätzliche statische Initialisierer

Blöcke der Art static { … } sind im Rumpf eines Aufzählungstyps erlaubt. Lädt die Laufzeitumgebung einer Klasse, initialisiert sie der Reihe nach alle statischen Variablen bzw. führt die static-Blöcke aus. Die Aufzählungen sind statische Variablen und werden beim Laden initialisiert. Steht der statische Initialisierer hinter den Konstanten, so wird auch er später aufgerufen als die Konstruktoren, die vielleicht auf statische Variablen zurückgreifen wollen, die der static-Block initialisiert. Ein Beispiel:

public enum Country {



  GERMANY, UK, CHINA;



  {

    System.out.println( "Objektinitialisierer" );

  }



  static {

    System.out.println( "Klasseninitialisierer" );

  }



  private Country() {

    System.out.println( "Konstruktor" );

  }



  public static void main( String[] args ) {

    System.out.println( GERMANY );

  }

}

Die Ausgabe ist:

Objektinitialisierer

Konstruktor

Objektinitialisierer

Konstruktor

Objektinitialisierer

Konstruktor

Klasseninitialisierer

GERMANY

Die Ausführung und Ausgabe hängt von der Reihenfolge der Deklaration ab, und jede Umsortierung führt zu einer Verhaltensänderung. Jetzt könnten Programmierer auf die Idee kommen, mögliche static-Blöcke an den Anfang zu setzen, vor die Konstanten. Meine Leser sollten das Ergebnis testen … Auf Konstruktoren kommen wir gleich noch zu sprechen.

Country mit zusätzlicher Objektmethode

Geben wir einer Aufzählung Country eine Methode, die den ISO-3166-2-Landescode des jeweiligen Aufzählungselements liefert:

Listing 10.38    src/main/java/com/tutego/insel/enums/Country.java, Ausschnitt

public enum Country {



  GERMANY, UK, CHINA;



  public String getISO3Country() {

    switch ( this ) {

      case GERMANY : return "DEU";

      case UK      : return "GBR";

      default      : return "CHN";

    }

  }

}

Die Methode getISO3Country() kann nun auf der Aufzählung aufgerufen werden:

System.out.println( Country.CHINA.getISO3Country() ); // CHN

Die switch-Anweisung ist auf Aufzählungen erlaubt, das ist komfortabel. Schreiben wir ein kleines Demoprogramm:

Listing 10.39    src/main/java/com/tutego/insel/enums/CountryEnumDemo.java, Ausschnitt

Country c = Country.GERMANY;



switch ( c ) {

  case GERMANY:

    System.out.println( "Aha. Ein Krauti" );         // Aha. Ein Krauti

    System.out.println( c.getISO3Country() );        // DEU

    break;

  default:

    System.out.println( "Anderes Land" );

}

 

10.7.3    enum mit eigenen Konstruktoren * 

Neben der ersten Variante für getISO3Country() wollen wir eine zweite Implementierung nutzen und nun Konstruktoren hinzuziehen, um das gleiche Problem auf andere Weise zu lösen:

Listing 10.40    src/main/java/com/tutego/insel/enums/Country2.java, Ausschnitt

public enum Country2 {



  GERMANY( "DEU" ),

  UK( "GBR" ),

  CHINA( "CHN" );



  private String iso3Country;



  Country2( String iso3Country ) {

    this.iso3Country = iso3Country;

  }



  public String getISO3Country() {

    return iso3Country;

  }

}

Bei der Deklaration der Konstanten wird in runden Klammern ein Argument für den Konstruktor übergeben. Der Konstruktor speichert den String in der internen Variablen iso3Country, auf die dann getISO3Country() Bezug nimmt.

enum mit überschriebenen Methoden

In dem Aufzählungstyp lassen sich nicht nur Methoden hinzufügen, sondern auch Methoden überschreiben. Beginnen wir mit einer lokalisierten und überladenen Methode toString():

Listing 10.41    src/main/java/com/tutego/insel/enums/WeekdayInternational.java, Ausschnitt

public enum WeekdayInternational {



  SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY;



  @Override

  public String toString() {

    return toString( Locale.getDefault() );

  }



  public String toString( Locale l ) {

    return new SimpleDateFormat( "", l ).getDateFormatSymbols()

                                        .getWeekdays()[ ordinal() + 1 ];

  }

}

Die erste Methode ist aus unserer Oberklasse Object überschrieben, die zweite als überladene Methode hinzugefügt. Ein Beispiel macht den Aufruf und die Funktionsweise klar:

Listing 10.42    src/main/java/com/tutego/insel/enums/WeekdayInternationalDemo.java, Ausschnitt

System.out.println( WeekdayInternational.SATURDAY ); 

// Samstag

System.out.println( WeekdayInternational.SATURDAY.toString() ); 

// Samstag

System.out.println( WeekdayInternational.SATURDAY.toString(Locale.FRANCE) ); 

// samedi

System.out.println( WeekdayInternational.SATURDAY.toString(Locale.ITALY) ); 

// sabato

An dieser Stelle hören die Möglichkeiten der enum-Syntax aber noch nicht auf. Ähnlich wie die Syntax von inneren anonymen Klassen, die es erlauben, Methoden zu überschreiben, bieten Aufzählungstypen eine vergleichbare Syntax, um gezielt Methoden für eine spezielle Konstante zu überschreiben.

Nehmen wir an, in einem Spiel gibt es eine eigene Währung, den Ponro-Dollar. Nun soll dieser aber zu einer Referenzwährung, dem Euro, in Beziehung gesetzt werden; der Wechselkurs ist einfach 1:2:

Listing 10.43    src/main/java/com/tutego/insel/enums/GameCurrency.java, Ausschnitt

public enum GameCurrency {



  EURO() {

    @Override public double convertTo( GameCurrency targetCurrency, double value ) {

      return targetCurrency == EURO ? value : value / 2;

    }

  },

  PONRODOLLAR() {

    @Override public double convertTo( GameCurrency targetCurrency, double value ) {

      return targetCurrency == PONRODOLLAR ? value : value * 2;

    }

  };



  public abstract double convertTo( GameCurrency targetCurrency, double value );

}

Der interessante Teil ist die Deklaration der abstrakten convertTo(…)-Methode und die lokale Implementierung bei den einzelnen Konstanten. (Natürlich müssen wir nicht jede Methode im enum abstrakt machen, sondern sie kann auch konkret sein. Dann muss nicht jedes enum-Element die abstrakte Methode implementieren.)

Mit einem statischen Import für die Aufzählung lässt sich die Nutzung und Funktionalität schnell zeigen:

Listing 10.44    src/main/java/com/tutego/insel/enums/GameCurrencyDemo.java, Ausschnitt

System.out.println( EURO.convertTo( EURO, 12 ) );               // 12.0

System.out.println( EURO.convertTo( PONRODOLLAR, 12 ) );        //  6.0

System.out.println( PONRODOLLAR.convertTo( EURO, 12 ) );        // 24.0

System.out.println( PONRODOLLAR.convertTo( PONRODOLLAR, 12 ) ); // 12.0

enum kann Schnittstellen implementieren

Die API-Dokumentation von Enum zeigt an, dass die abstrakte Klasse zwei Schnittstellen implementiert: Comparable und Serializable. Jede in enum deklarierte Konstante ist eine Unterklasse von Enum, also immer vergleichbar und standardmäßig serialisierbar. Neben diesen Standardschnittstellen kann ein enum andere Schnittstellen implementieren. Das ist sehr nützlich, denn so schreibt es für alle Aufzählungselemente ein bestimmtes Verhalten vor – jedes Aufzählungselement bietet dann diese Operationen. Die Operationen der Schnittstelle können auf zwei Arten realisiert werden: Das enum selbst implementiert die Operationen der Schnittstelle im Rumpf, oder die einzelnen Aufzählungselemente realisieren die Implementierungen jeweils unterschiedlich. Oftmals dürfte es so sein, dass die Elemente unterschiedliche Implementierungen bereitstellen.

Unser nächstes Beispiel für ein enum DefaultIcons implementiert die Schnittstelle Icon für grafische Symbole. Da die Symbole alle die gleichen Ausmaße haben, sind die Icon-Operationen getIconWidth() und getIconHeight() immer gleich und werden nur einmal implementiert; die tatsächlichen paintIcon(…)-Implementierungen (die hier nur angedeutet werden) unterscheiden sich.

Listing 10.45    src/main/java/com/tutego/insel/enums/DefaultIcons.java, Ausschnitt

public enum DefaultIcons implements Icon {



  WARNING {

    @Override public void paintIcon( Component c, Graphics g, int x, int y ) {

      // g.drawXXX()

    } },

  ERROR {

    @Override public void paintIcon( Component c, Graphics g, int x, int y ) {

      // g.drawXXX()

    } };



  @Override public int getIconWidth() { return 16; }



  @Override public int getIconHeight() { return 16; }

}

Der Zugriff DefaultIcons.ERROR gibt ein Objekt, das unter anderem vom Typ Icon ist und an allen Stellen übergeben werden kann, an denen ein Icon gewünscht ist.