com.google.devtools.common.options

Class EnumConverter<T extends java.lang.Enum<T>>

java.lang.Object

com.google.devtools.common.options.EnumConverter<T>

All Implemented Interfaces:

Converter<T>

Direct Known Subclasses:

BoolOrEnumConverter, Converters.HelpVerbosityConverter

public abstract class EnumConverter<T extends java.lang.Enum<T>>
extends java.lang.Object
implements Converter<T>

A converter superclass for converters that parse enums.

Just subclass this class, creating a zero aro argument constructor that calls EnumConverter(Class, String).

This class compares the input string to the string returned by the toString() method of each enum member in a case-insensitive way. Usually, this is the name of the symbol, but beware if you override toString()!

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EnumConverter(java.lang.Class<T> enumType, java.lang.String typeName) Creates a new enum converter.

Method Summary

Modifier and Type	Method and Description
T	convert(java.lang.String input) Implements convert(String).
java.lang.String	getTypeDescription() Implements getTypeDescription().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnumConverter

protected EnumConverter(java.lang.Class<T> enumType,
                        java.lang.String typeName)

Creates a new enum converter. You *must* implement a zero-argument constructor that delegates to this constructor, passing in the appropriate parameters.

Parameters:

enumType - The type of your enumeration; usually a class literal like MyEnum.class

typeName - The intuitive name of your enumeration, for example, the type name for CompilationMode might be "compilation mode".

Method Detail

convert

public T convert(java.lang.String input)
          throws OptionsParsingException

Implements convert(String).

Specified by:

convert in interface Converter<T extends java.lang.Enum<T>>

Throws:

OptionsParsingException

getTypeDescription

public final java.lang.String getTypeDescription()

Implements getTypeDescription().

Specified by:

getTypeDescription in interface Converter<T extends java.lang.Enum<T>>