Enum-Klasse

Programmiersprachen stellen üblicherweise die Syntax zum Deklarieren einer Enumeration bereit, die aus einer Gruppe benannter Konstanten und deren Werten besteht. Im folgenden Beispiel wird die von C# und Visual Basic verwendete Syntax zum Definieren einer Enumeration veranschaulicht. Eine Enumeration mit dem Namen ArrivalStatus wird erstellt, der über drei Member verfügt: ArrivalStatus.Early, ArrivalStatus.OnTime und ArrivalStatus.Late. Beachten Sie, dass in beiden Fällen die Enumeration nicht explizit von Enum erbt; die Vererbungsbeziehung wird implizit vom Compiler behandelt.

Vorsicht
Sie sollten einen Enumerationstyp nie erstellen, dessen zugrunde liegender Typ keine Ganzzahl oder Char ist. Obwohl Sie solch einen Enumerationstyp mit Reflektion erstellen können, sind Methodenaufrufe, die den resultierenden Typ verwenden, unzuverlässig und lösen möglicherweise auch zusätzliche Ausnahmen aus.

Sie können einen Enumerationstyp so instanziieren, wie Sie einen beliebigen anderen Werttyp instanziieren: durch das Deklarieren einer Variablen und Zuweisen einer der Konstanten der Enumeration. Im folgenden Beispiel wird ein ArrivalStatus, dessen Wert ArrivalStatus.OnTime ist, instanziiert.

Sie können auch auf die folgende Weise einen Enumerationswert instanziieren:

• Mit den Funktionen einer bestimmten Programmiersprache, um einen ganzzahligen Wert in einen Enumerationswert umzuwandeln (wie in C#) oder zu konvertieren (wie in Visual Basic). Im folgenden Beispiel wird ein ArrivalStatus-Objekt erstellt, dessen Wert auf diese Weise gleich ArrivalStatus.Early ist.

  C#

  VB

  F#

  Kopieren

  Derzeit ist kein Code Beispiel verfügbar, oder die Sprache wird nicht unterstützt.

• Durch Aufrufen von dessen implizitem Standardkonstruktor. Wie das folgende Beispiel zeigt, beträgt der zugrunde liegende Wert der Enumerationsinstanz in diesem Fall 0. Dies ist notwendigerweise jedoch nicht der Wert einer gültigen Konstante in der Enumeration.

  C#

  VB

  F#

  Kopieren

  Derzeit ist kein Code Beispiel verfügbar, oder die Sprache wird nicht unterstützt.

• Durch das Aufrufen der Parse-Methode oder TryParse-Methode, um eine Zeichenfolge zu analysieren, die den Namen einer Konstante in der Enumeration enthält. Weitere Informationen finden Sie im Abschnitt Analyse von Enumerationswerten.

• Durch das Aufrufen der ToObject-Methode, um einen ganzzahligen Wert in einen Enumerationstyp zu konvertieren. Weitere Informationen finden Sie im Abschnitt Ausführen von Konvertierungen.

Es empfiehlt sich, dass Sie die folgenden Best Practices verwenden, wenn Sie Enumerationstypen definieren:

• Wenn Sie keinen Enumerationsmember definiert haben, dessen Wert 0 ist, erwägen Sie, eine aufgelistete None-Konstante zu erstellen. Der für die Enumeration verwendete Speicher wird von der Common Language Runtime standardmäßig mit 0 (null) initialisiert. Daher enthält die Enumeration einen ungültigen Wert, wenn Sie sie erstellen, ohne eine Konstante zu definieren, deren Wert 0 (null) ist.

• Wenn für die Anwendung ein offensichtlicher Standardfall erforderlich ist, sollten Sie für dessen Darstellung eine Enumerationskonstante verwenden, deren Wert 0 (null) ist. Wenn kein Standardwert erforderlich ist, sollten Sie eine Enumerationskonstante mit dem Wert 0 (null) verwenden. Damit wird der Fall dargestellt, für den keine anderen Enumerationskonstanten festgelegt wurden.

• Geben Sie keine Enumerationskonstanten an, die für die zukünftige Verwendung reserviert sind.

• Wenn Sie eine Methode oder Eigenschaft definieren, die eine Enumerationskonstante als Wert akzeptiert, sollten Sie den Wert validieren. Sie können dann einen numerischen Wert in den Enumerationstyp konvertieren, auch wenn der numerische Wert nicht in der Enumeration definiert ist.

Weitere Best Practices für Enumerationstypen, deren Konstanten Bitfelder sind, sind im Abschnitt Nicht ausschließliche Member und das Flags-Attribut aufgeführt.

Beim Erstellen einer Enumeration können Sie keine neuen Methoden definieren. Ein Enumerationstyp erbt jedoch einen vollständigen Satz von statischen Methoden und Instanzmethoden von der Enum-Klasse. Die folgenden Abschnitte untersuchen die meisten dieser Methoden, zusätzlich zu mehreren anderen Methoden, die häufig beim Arbeiten mit Enumerationswerten verwendet werden.

Ausführen von Konvertierungen

Analysieren von Enumerationswerten

Formatieren von Enumerationswerten

Durchlaufen von Enumerationsmembern

Eine allgemeine Verwendung einer Enumeration ist, einen Satz sich gegenseitig ausschließender Werte darzustellen. Eine ArrivalStatus-Instanz kann z. B. über den Wert Early, OnTime oder Late verfügen. Es ergibt keinen Sinn für den Wert einer ArrivalStatus-Instanz, mehr als eine Enumerationskonstante zu reflektieren.

In anderen Fällen jedoch kann der Wert eines Enumerationsobjekts mehrere Enumerationsmember enthalten, und jeder Member vertritt ein Bitfeld im Enumerationswert. Das FlagsAttribute-Attribut kann verwendet werden, um anzugeben, dass die Enumeration aus Bitfeldern besteht. Eine Enumeration mit dem Namen Pets könnte z. B. verwendet werden, um die Arten von Haustieren in einem Haushalt anzugeben. Folgende Definition ist möglich.

Die Pets-Enumeration kann dann verwendet werden, wie im folgenden Beispiel gezeigt.

Die folgenden Best Practices sollten verwendet werden, wenn Sie eine bitweise Enumeration definieren und das FlagsAttribute-Attribut übernehmen.

• Verwenden Sie das benutzerdefinierte FlagsAttribute-Attribut nur dann für eine Enumeration, wenn eine bitweise Operation (AND, OR, EXCLUSIVE OR) mit einem numerischen Werte ausgeführt werden soll.

• Definieren Sie Enumerationskonstanten in Potenzen von zwei, d. h., 1, 2, 4, 8 usw. Dies bedeutet, dass sich die einzelnen Flags in kombinierten Enumerationskonstanten nicht überschneiden.

• Sie sollten eine Enumerationskonstante für häufig verwendete Flagkombinationen erstellen. Wenn Sie z. B. über eine Enumeration für Datei-E/A-Vorgänge verwenden, die die Enumerationskonstanten Read = 1 und Write = 2 enthält, sollten Sie die Enumerationskonstante ReadWrite = Read OR Write erstellen, die das Read-Flag und das Write-Flag zusammenfasst. Außerdem könnte der zum Kombinieren der Flags verwendete bitweise OR-Vorgang in bestimmten Situationen als erweitertes Konzept angesehen werden, in denen einfache Aufgaben ausgeführt werden sollten.

• Seien Sie beim Definieren negativer Zahlen als Flagenumerationskonstanten umsichtig, da viele Flagpositionen auf 1 festgelegt werden, wodurch der Code verwirren und Codierungsfehler verursachen könnte.

• Eine zweckmäßige Möglichkeit, zu testen, ob ein Flag in einem numerischen Wert festgelegt wird, besteht im Aufrufen der HasFlag-Instanzmethode, wie im folgenden Beispiel gezeigt.

  C#

  VB

  F#

  Kopieren

  Derzeit ist kein Code Beispiel verfügbar, oder die Sprache wird nicht unterstützt.

  Dies entspricht der Ausführung eines bitweisen AND-Vorgangs zwischen dem numerischen Wert und der Flagenumerationskonstante, bei dem alle Bits der numerischen Werte, die nicht dem Flag entsprechen, auf 0 (null) festgelegt werden, und dem anschließenden Test, ob das Ergebnis des Vorgangs gleich der Flagenumerationskonstante ist. Dies ist im folgenden Codebeispiel gezeigt.

  C#

  VB

  F#

  Kopieren

  Derzeit ist kein Code Beispiel verfügbar, oder die Sprache wird nicht unterstützt.

• Verwenden Sie als Namen der Flagenumerationskonstante None, dessen Wert 0 (null) ist. Sie können die None-Enumerationskonstante nicht in einem bitweisen AND-Vorgang zum Testen eines Flags verwenden, da das Ergebnis immer 0 (null) ist. Sie können aber einen logischen (nicht bitweisen) Vergleich des numerischen Werts und der None-Enumerationskonstante durchführen, um zu bestimmen, ob in dem numerischen Wert Bits festgelegt wurden. Dies ist im folgenden Codebeispiel gezeigt.

  C#

  VB

  F#

  Kopieren

  Derzeit ist kein Code Beispiel verfügbar, oder die Sprache wird nicht unterstützt.

• Definieren Sie keinen Enumerationswert, um ausschließlich den Zustand der Enumeration selbst darzustellen. Definieren Sie beispielsweise keine Enumerationskonstante, die lediglich das Ende der Enumeration kennzeichnet. Wenn Sie den letzten Wert der Enumeration bestimmen müssen, überprüfen Sie diesen Wert explizit. Sie können des Weiteren eine Bereichsprüfung für die erste und letzte Enumerationskonstante durchführen, wenn alle Werte in dem Bereich gültig sind.