EnumConverter (JOpt Simple 5.0.4 API)

java.lang.Object
- joptsimple.util.EnumConverter<E>

All Implemented Interfaces:: ValueConverter<E>

public abstract class EnumConverter<E extends Enum<E>>
extends Object
implements ValueConverter<E>

Converts values to Enums.

Author:: Christian Ohr

Constructor Summary

Constructors
Modifier Constructor Description

protected EnumConverter(Class<E> clazz)
This constructor must be called by subclasses, providing the enum class as the parameter.

Constructors
Modifier	Constructor	Description
`protected`	`EnumConverter(Class<E> clazz)`	This constructor must be called by subclasses, providing the enum class as the parameter.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`E`	`convert(String value)`	Converts the given string value into a Java type.
`void`	`setDelimiters(String delimiters)`	Sets the delimiters for the message string.
`String`	`valuePattern()`	Gives a string that describes the pattern of the values this converter expects, if any.
`Class<E>`	`valueType()`	Gives the class of the type of values this converter converts to.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EnumConverter
```
protected EnumConverter(Class<E> clazz)
```
    This constructor must be called by subclasses, providing the enum class as the parameter.
    
    Parameters:
    
    clazz - enum class
- Method Detail
  - convert
```
public E convert(String value)
```
    Description copied from interface: ValueConverter
    
    Converts the given string value into a Java type.
    
    Specified by:
    
    convert in interface ValueConverter<E extends Enum<E>>
    
    Parameters:
    
    value - the string to convert
    
    Returns:
    
    the converted value
  - valueType
```
public Class<E> valueType()
```
    Description copied from interface: ValueConverter
    
    Gives the class of the type of values this converter converts to.
    
    Specified by:
    
    valueType in interface ValueConverter<E extends Enum<E>>
    
    Returns:
    
    the target class for conversion
  - setDelimiters
```
public void setDelimiters(String delimiters)
```
    Sets the delimiters for the message string. Must be a 3-letter string, where the first character is the prefix, the second character is the delimiter between the values, and the 3rd character is the suffix.
    
    Parameters:
    
    delimiters - delimiters for message string. Default is [,]
  - valuePattern
```
public String valuePattern()
```
    Description copied from interface: ValueConverter
    
    Gives a string that describes the pattern of the values this converter expects, if any. For example, a date converter can respond with a date format string.
    
    Specified by:
    
    valuePattern in interface ValueConverter<E extends Enum<E>>
    
    Returns:
    
    a value pattern, or null if there's nothing interesting here

Class EnumConverter<E extends Enum<E>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnumConverter

Method Detail

convert

valueType

setDelimiters

valuePattern