6.4 Konstanten und Aufzählungen

In Programmen gibt es Variablen, die sich ändern wie ein Schleifenzähler, aber auch andere, die sich beim Ablauf eines Programms nicht ändern. Dazu gehören etwa die Startzeit der Tagesschau oder die Ausmaße einer DIN-A4-Seite [Ein DIN-A4-Blatt ist 29,7 Zentimeter hoch und 21,0 Zentimeter breit. ] . Die Werte sollten nicht wiederholt im Quellcode stehen, sondern über ihre Namen angesprochen werden. Dazu werden Variablen deklariert, denen genau der konstante Wert zugewiesen wird; die Konstanten heißen dann symbolische Konstanten.

In Java gibt es zur Deklaration von Konstanten zwei Möglichkeiten:

• Öffentliche statische finale Variablen nehmen konstante Werte auf.

• Aufzählungen über ein enum (die intern aber auch nur öffentliche final statische Werte sind).

6.4.1 Konstanten über öffentliche statische finale Variablen

Statische Variablen werden auch verwendet, um symbolische Konstanten zu deklarieren. Damit die Variablen unveränderlich bleiben, gesellt sich der Modifizierer final hinzu. Dem Compiler wird auf diese Weise mitgeteilt, dass dieser Variable nur einmal ein Wert zugewiesen werden darf. Für Variablen bedeutet dies: Es sind Konstanten, jeder spätere Schreibzugriff wäre ein Fehler.

Konstante Werte haben wir schon bei GameUtils eingesetzt:

Listing 6.23 GameUtils, Ausschnitt

public class GameUtils 
{ 
  public static final double MAX_ID_LEN = 20 /* chars */; 
  ... 
}

Da im Quellcode das Vorkommen von Zahlen wie die 20 undurchsichtig wären, sind symbolische Namen zwingend. Stehen dennoch Zahlen ohne offensichtliche Bedeutung im Quellcode, so werden sie magische Zahlen (engl. magic numbers) genannt. Es gilt, diese Werte in Konstanten zu fassen und sinnvoll zu benennen.

Der Zugriff auf die Variablen sieht genauso aus wie ein Zugriff auf andere statische Variablen.

System.out.println( Math.PI ); 
int len = GameUtils.MAX_ID_LEN; 
if ( string.length() >= GameUtils.MAX_ID_LEN ) 
  System.out.println( "Zu lang!" );

6.4.2 Eincompilierte Belegungen der Klassenvariablen

Finale Klassenvariablen können in der Entwicklung mit einer größeren Anzahl von Klassen zu einem Problem werden. Das liegt an der Eigenschaft der finalen Werte, dass sie sich nicht ändern können und sich daher sicher an der Stelle einsetzen lassen, wo sie gebraucht werden. Ein Beispiel:

class Finance 
{ 
  public static final int TAX = 19; 
}

Greift eine andere Klasse auf die Variable TAX zu, ist das im Quellcode nicht als direkter Variablenzugriff Finance.TAX kodiert, sondern der Compiler hat das Literal 19 direkt an jede Aufrufstelle eingesetzt. Dies ist eine Optimierung des Compilers, die er laut Java-Spezifikation machen kann.

Das ist zwar nett, bringt aber gewaltige Probleme mit sich, etwa dann, wenn sich die Konstante einmal ändert. Dann muss nämlich auch jede Klasse übersetzt werden, die Bezug auf die Konstante hatte. Werden die abhängigen Klassen nicht neu übersetzt, ist in ihnen immer noch der alte Wert eincompiliert.

Die Lösung ist, die Bezug nehmenden Klassen neu zu übersetzen und sich am besten anzugewöhnen, bei einer Änderung einer Konstante gleich alles neu zu compilieren. Ein anderer Weg transformiert die finale Variable in eine später initialisierte Form:

class Finance 
{ 
  public static final int TAX = Integer.valueOf( 19 ); 
}

Die Initialisierung findet in jedem Konstruktor statt, und die Konstante mit dem Literal 19 ist zunächst einmal verschwunden. Der Compiler wird also beim Zugriff auf Finance.TAX nicht die 19 vorfinden und daher das Literal an den Aufrufstellen nicht einbauen können. In der Klassendatei wird der Bezug Finance.TAX weiterhin zu finden sein, und eine Änderung der Konstante erzwingt keine neue Übersetzung der Klassen.

6.4.3 Typ(un)sicherere Aufzählungen

Konstanten sind eine wertvolle Möglichkeit, den Quellcode aussagekräftiger zu machen. Das gilt auch für Aufzählungen, also diverse Konstanten, die für unterschiedliche Ausprägungen stehen. Eine Klasse Materials soll zum Beispiel Konstanten für die Beschaffenheit eines Materials deklarieren:

Listing 6.24 Materials.java

public class Materials 
{ 
  public static final int SOFT   = 0; 
  public static final int HARD   = 1; 
  public static final int DRY    = 2; 
  public static final int WET    = 3; 
  public static final int SMOOTH = 4; 
  public static final int ROUGH  = SMOOTH + 1; 
}

Für ihre Belegungen ist es günstig, sie relativ zum Vorgänger zu wählen, um das Einfügen in der Mitte zu vereinfachen. Das sehen wir bei der vorletzten Variable ROUGH.

Einfache Konstantentypen – wie bei uns int – bringen jedoch den Nachteil mit sich, dass die Konstanten nicht unbedingt von jedem angewendet werden müssen und ein Programmierer die Zahlen oder Zeichenketten eventuell direkt einsetzt. Dieses Problem ergibt sich zum Beispiel dann, wenn ein Font-Objekt für die grafische Oberfläche angelegt werden soll, aber unser Gedächtnis versagt, in welcher Reihenfolge die Parameter zu füllen sind. Ein Fallbeispiel:

Font f = new Font( "Dialog", 12, Font.BOLD );

Leider ist dies falsch, denn die Argumente für die Zeichensatzgröße und den Schriftstil sind vertauscht, es müsste new Font("Dialog", Font.BOLD, 12) heißen. Das Problem ist, dass die Konstanten nur Namen für Werte eines frei zugänglichen Grundtyps (auch hier int) sind und nur die Variablenbelegung, also der Wert, an die Funktion übergeben wird. Niemand kann verbieten, dass die Werte direkt eingetragen werden. Das führt dann zu Fehlern wie im oberen Fall. In diesem ist 12 die Ganzzahl für den Schriftstil, obwohl es dafür nur die Werte 0, 1, 2 geben sollte. Mit Zeichenketten als Werten der Konstanten kommen wir der Lösung auch nicht näher.

Eine gute Möglichkeit, von Ganzzahlen wegzukommen, ist, Objekte einer Klasse als Konstanten einzusetzen. Java bietet seit der Version 5 ein Sprachkonstrukt über das neue Schlüsselwort enum für richtige Aufzählungen.

6.4.4 Aufzählungen mit enum

In der Schreibweise für Aufzählungen ersetzt das Schlüsselwort enum das Schlüsselwort class und ist auch ähnlich zu nutzen. (Eine enum-Deklaration erlaubt auch die Deklaration von Methoden und Variablen. Somit verhält sie sich wie eine bekannte Klassendeklaration, nur dass keine Unterklassen und Oberklassen möglich sind.)

Aufzählungen für Wochentage sind ein gutes Beispiel:

Listing 6.25 com/tutego/weekday/Weekday.java

package com.tutego.weekday; 
 
public enum Weekday 
{ 
  MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY 
}

Die Konstantennamen werden wie üblich großgeschrieben.

Enums nutzen

Um zu verstehen, wie sich Enums nutzen lassen, ist es hilfreich zu wissen, wie sie der Compiler umsetzt. Intern erstellt der Compiler eine normale Klasse, in unserem Fall Weekday. Alle Aufzählungselemente sind dann statische Variablen (Konstanten) vom Typ des Enums:

class Weekday 
{ 
  public static final Weekday MONDAY; 
  public static final Weekday TUESDAY; 
  ... 
}

Jetzt ist es einfach, diese Werte zu nutzen, da sie wie jede andere statische Variable angesprochen werden:

Weekday weekend = Weekday.SATURDAY;

Hinter den Aufzählungen stehen also einzelne Objekte, die sich – wie alle anderen – weiterverarbeiten lassen, das heißt: etwa in eine Datenstruktur einsetzen lassen.

enum-Konstanten in switch

enum-Konstanten sind in switch-Anweisungen möglich. (Das ist möglich, da sie intern über eine Ganzzahl als Identifizierer verfügen, den der Compiler für die Aufzählung einsetzt.)

Initialisieren wir eine Variable vom Typ Weekday, und nutzen wir eine Fallunterscheidung mit der Aufzählung für einen Test auf das Wochenende:

Listing 6.26 WeekdayDemo.java, Ausschnitt main()

Weekday day = Weekday.MONDAY; 
switch ( day ) 
{ 
  case SATURDAY:               // nicht Weekday.SATURDAY! 
  case SUNDAY: System.out.println( "Wochenende. Party!" ); 
}

Standard-Methoden der Enums

Die erzeugten enum-Objekte bekommen standardmäßig eine Reihe von zusätzlichen Eigenschaften. Sie überschreiben sinnvoll toString(), hashCode() und equals() aus Object und implementieren zusätzlich Serializable und Comparable [Die Ordnung der Konstanten ist die Reihenfolge, in der sie geschrieben sind. ] , aber nicht Cloneable, da Aufzählungsobjekte nicht geklont werden können. Es liefert toString() den Name, der Konstante, sodass Weekday.SUNDAY.toString().equals("SUNDAY") wahr ist. Zusätzlich erbt jedes Aufzählungsobjekt von der Spezialklasse Enum, die später erklärt wird.

Referenzen auf Enum-Objekte können null sein

Dass die Aufzählungen nur Objekte sind, hat eine wichtige Konsequenz. Blicken wir zunächst auf eine Variablendeklaration vom Typ eines enum, die mit einem Wochentag initialisiert ist:

Weekday day = Weekday.MONDAY;

Die Variable day speichert einen Verweis auf das Weekday.MONDAY-Objekt. Das Unschöne an Referenz-Variablen ist allerdings, dass sie auch mit null belegt werden können, was so gesehen kein Element der Aufzählung ist:

Weekday day = null;

Wenn solch eine null-Referenz in einem switch landet, gibt es eine NullPointerException, da versteckt im switch ein Zugriff auf die im Enum-Objekt gespeicherte Ordinalzahl stattfindet.

Methoden, die Elemente einer Aufzählung, also Objektverweise, entgegennehmen, sollten im Allgemeinen auf null testen und eine Ausnahme auslösen, um diesen fehlerhaften Teil anzuzeigen:

public void setWeekday( Weekday day ) 
{ 
  if ( day == null ) 
    throw new IllegalArgumentException( "null is not a valid argument!" ); 
  this.day = day; 
}

Innere Aufzählungen

Es gibt »normale« Aufzählungen, die an normale Klassen erinnern, und auch »innere« Aufzählungen, die an innere Klassen erinnern. Mit anderen Worten: Weekday kann auch innerhalb einer anderen Klasse deklariert werden. Ist die innere Aufzählung öffentlich, kann sie jeder nutzen. Sie folgt aber den gleichen Sichtbarkeiten wie Klassen, da sie ja nichts anderes als Klassen sind, die der Compiler generiert.

Statische Imports von Aufzählungen

Die Aufzählung Weekday hatten wir in das Paket com.tutego.weekday gesetzt. Um auf eine Konstante wie MONDAY zugreifen zu können, wollen wir unterschiedliche import-Varianten nutzen.

Nehmen wir im Paket als zweites Beispiel eine innere Aufzählung der Klasse Week hinzu:

package com.tutego.weekday; 
 
public class Week 
{ 
  public enum Weekday { 
    MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY 
  } 
}

Ihr Kommentar