snaq.util.jclap

Class LocalDateOption

java.lang.Object

snaq.util.jclap.Option<LocalDate>

snaq.util.jclap.LocalDateOption

public class LocalDateOption
extends Option<LocalDate>

Option implementation for specifying date values.

Author:

Giles Winstanley

Field Summary

Fields inherited from class snaq.util.jclap.Option

bundle, ILLEGAL_SN_CHARS, locale, MAX_COUNT_LIMIT, MIN_COUNT_LIMIT, values

Constructor Summary

Constructors

Constructor and Description
LocalDateOption(String shortName, String longName, String description, boolean mandatory, boolean allowMany)
LocalDateOption(String shortName, String longName, String description, int minCount, int maxCount)

Method Summary

Modifier and Type	Method and Description
DateTimeFormatter	getDateFormat()
Class<LocalDate>	getType() Returns the class type of value this option can take.
static void	main(String[] args)
protected LocalDate	parseValue(String arg) Parses the argument string for an option value.

Methods inherited from class snaq.util.jclap.Option

addValue, equals, getDescription, getLongName, getMaxCount, getMinCount, getShortName, getUsageTypeString, getValues, hashCode, isAllowMany, isHidden, isMandatory, requiresValue, setHidden, setMinMaxCounts, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LocalDateOption

public LocalDateOption(String shortName,
                       String longName,
                       String description,
                       boolean mandatory,
                       boolean allowMany)

LocalDateOption

public LocalDateOption(String shortName,
                       String longName,
                       String description,
                       int minCount,
                       int maxCount)

Method Detail

getType

public Class<LocalDate> getType()

Description copied from class: Option

Returns the class type of value this option can take.

Specified by:

getType in class Option<LocalDate>

Returns:

Class instance

parseValue

protected LocalDate parseValue(String arg)
                        throws OptionException

Description copied from class: Option

Parses the argument string for an option value. (e.g. Converts "123" to an Integer instance representing 123).

Specified by:

parseValue in class Option<LocalDate>

Parameters:

arg - string argument from which a value is to be parsed

Returns:

Value of the parsed argument string

Throws:

OptionException - if a problem occurs while parsing the argument string

getDateFormat

public DateTimeFormatter getDateFormat()

Returns:

The DateFormat instance used to parse dates.

main

public static void main(String[] args)
                 throws OptionException

Throws:

OptionException