Package ubic.gemma.cli.util

Class EnumeratedStringConverter

java.lang.Object

ubic.gemma.cli.util.EnumeratedStringConverter

All Implemented Interfaces:

org.apache.commons.cli.Converter<String,IllegalArgumentException>, EnumeratedConverter<String,IllegalArgumentException>

public class EnumeratedStringConverter
extends Object
implements EnumeratedConverter<String,IllegalArgumentException>

A string converter that can only convert from a finite set of possible values.

Author:

poirigui

Field Summary

Fields inherited from interface org.apache.commons.cli.Converter

CLASS, DATE, DEFAULT, FILE, NUMBER, OBJECT, PATH, URL

Method Summary

Modifier and Type	Method	Description
String	apply(String string)
Map<String,org.springframework.context.MessageSourceResolvable>	getPossibleValues()	Obtain a list of possible values that the converter can convert to EnumeratedConverter.
static EnumeratedStringConverter	of(String... possibleValues)
static EnumeratedStringConverter	of(Map<String,org.springframework.context.MessageSourceResolvable> descriptions)

Methods inherited from class java.lang.Object

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

Method Details

of

public static EnumeratedStringConverter of(String... possibleValues)

of

public static EnumeratedStringConverter of(Map<String,org.springframework.context.MessageSourceResolvable> descriptions)

getPossibleValues

public Map<String,org.springframework.context.MessageSourceResolvable> getPossibleValues()

Description copied from interface: EnumeratedConverter

Obtain a list of possible values that the converter can convert to EnumeratedConverter.

Implementation should use either a SortedMap or LinkedHashMap for reproducibility.

Specified by:

getPossibleValues in interface EnumeratedConverter<String,IllegalArgumentException>

apply

public String apply(String string)
             throws IllegalArgumentException

Specified by:

apply in interface org.apache.commons.cli.Converter<String,IllegalArgumentException>

Throws:

IllegalArgumentException