20.11. Testing for a Valid Enumeration Value
Problem
When you pass a numeric value to a method that accepts an enumeration type, it is possible to pass a value that does not exist in the enumeration. You want to perform a test before using this numeric value to determine if it is indeed one of the ones defined in this enumeration type.
Solution
To prevent this problem, test for the specific enumeration values that you allow for the enumeration-type parameter using a switch statement to list the values.
Using the following Language enumeration:
enum Language
{
Other = 0, CSharp = 1, VBNET = 2, VB6 = 3
}Suppose you have a method that accepts the Language enumeration, such as the following method:
public void HandleEnum(Language language)
{
// Use language here...
}You need a method to define the enumeration values you can accept in HandleEnum. The CheckLanguageEnumValue method shown here does that:
public static bool CheckLanguageEnumValue(Language language)
{
switch (language)
{
// All valid types for the enum listed here
// This means only the ones we specify are valid
// Not any enum value for this enum
case Language.CSharp:
case Language.Other:
case Language.VB6:
case Language.VBNET:
break;
default:
Debug.Assert(false, language +
" is not a valid enumeration value to pass.");
return false;
}
return true;
}Discussion
Although the Enum class contains the static IsDefined method, it should not be used. IsDefined uses reflection internally, which incurs a performance penalty. Also, versioning ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access