com.easy.argparse

Class UsageToken

java.lang.Object

com.easy.argparse.UsageToken

public class UsageToken
extends Object

This thread-safe class represents a usage token present in the usage expression. For example, usage expression -m minute [-s seconds] has two usage tokens: one corresponding to -m minute and another one corresponding to -s seconds

Author:

himanshu_shekhar

Constructor Summary

Constructors

Constructor and Description
UsageToken(String optionName, String optionAliasName, String dataVariableName)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDataVariableName()
Field	getMappedField(Class<?> dataClass)
String	getOptionAliasName()
String	getOptionName()
Method	getSetterMethod(Class<?> dataClass)
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

UsageToken

public UsageToken(String optionName,
                  String optionAliasName,
                  String dataVariableName)

Parameters:

optionName - The option switch, e.g. m is an option name in usage expression -m minute [-s seconds]

optionAliasName - The alias if any for the option, e.g. min is an alias in usage expression -m|--min minute [-s seconds]

dataVariableName - The name corresponding to variable in data class, e.g. minute is data variable name in usage expression -m minute [-s seconds]

Method Detail

getOptionName

public String getOptionName()

Returns:

The name of option switch

getOptionAliasName

public String getOptionAliasName()

Returns:

The alias name for the option switch

getDataVariableName

public String getDataVariableName()

Returns:

The name of corresponding variable name in the data class

getMappedField

public Field getMappedField(Class<?> dataClass)

Parameters:

dataClass - The data class which will keep the values available in command line arguments

Returns:

Reference to corresponding Field in the data class

Throws:

IllegalArgumentException - If corresponding field could not be found

getSetterMethod

public Method getSetterMethod(Class<?> dataClass)

Parameters:

dataClass - The data class which will keep the values available in command line arguments

Returns:

Reference to corresponding setter method in the data class

Throws:

IllegalArgumentException - If corresponding setter method could not be found

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object