Package joptsimple.util
Class DateConverter
- java.lang.Object
-
- joptsimple.util.DateConverter
-
- All Implemented Interfaces:
ValueConverter<Date>
public class DateConverter extends Object implements ValueConverter<Date>
Converts values toDate
s using aDateFormat
object.- Author:
- Paul Holser
-
-
Constructor Summary
Constructors Constructor Description DateConverter(DateFormat formatter)
Creates a converter that uses the given date formatter/parser.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Date
convert(String value)
Converts the given string value into a Java type.static DateConverter
datePattern(String pattern)
Creates a converter that uses aSimpleDateFormat
with the given date/time pattern.String
valuePattern()
Gives a string that describes the pattern of the values this converter expects, if any.Class<Date>
valueType()
Gives the class of the type of values this converter converts to.
-
-
-
Constructor Detail
-
DateConverter
public DateConverter(DateFormat formatter)
Creates a converter that uses the given date formatter/parser.- Parameters:
formatter
- the formatter/parser to use- Throws:
NullPointerException
- ifformatter
isnull
-
-
Method Detail
-
datePattern
public static DateConverter datePattern(String pattern)
Creates a converter that uses aSimpleDateFormat
with the given date/time pattern. The date formatter created is notlenient
.- Parameters:
pattern
- expected date/time pattern- Returns:
- the new converter
- Throws:
NullPointerException
- ifpattern
isnull
IllegalArgumentException
- ifpattern
is invalid
-
convert
public Date convert(String value)
Description copied from interface:ValueConverter
Converts the given string value into a Java type.- Specified by:
convert
in interfaceValueConverter<Date>
- Parameters:
value
- the string to convert- Returns:
- the converted value
-
valueType
public Class<Date> valueType()
Description copied from interface:ValueConverter
Gives the class of the type of values this converter converts to.- Specified by:
valueType
in interfaceValueConverter<Date>
- Returns:
- the target class for conversion
-
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 adate format string
.- Specified by:
valuePattern
in interfaceValueConverter<Date>
- Returns:
- a value pattern, or
null
if there's nothing interesting here
-
-