com.easy.argparse

Class UsageTokenManager

java.lang.Object

com.easy.argparse.UsageTokenManager

public class UsageTokenManager
extends Object

This thread-safe class extracts and manages the mandatory and optional usage tokens from given usage expression

Author:

himanshu_shekhar

Constructor Summary

Constructors

Constructor and Description
UsageTokenManager(String usageExpression, Class<?> dataClass)

Method Summary

Modifier and Type	Method and Description
UsageToken	findUsageToken(String option)
Method	getSetterMethod(UsageToken usageToken)
void	initialize() Initialize and update the data structures representing mandatory and optional usage tokens
boolean	isMissingMandatoryOption(Set<UsageToken> availableUsageTokens)
boolean	noTokensAvailable()
void	validateVariableNames() Validate the data class for mandatory and optional usage tokens

Methods inherited from class java.lang.Object

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

Constructor Detail

UsageTokenManager

public UsageTokenManager(String usageExpression,
                         Class<?> dataClass)

Parameters:

usageExpression - The usage expression for the input format of command line arguments

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

Method Detail

initialize

public void initialize()

Initialize and update the data structures representing mandatory and optional usage tokens

validateVariableNames

public void validateVariableNames()

Validate the data class for mandatory and optional usage tokens

Throws:

IllegalArgumentException - If data class is not valid

isMissingMandatoryOption

public boolean isMissingMandatoryOption(Set<UsageToken> availableUsageTokens)

Parameters:

availableUsageTokens - Set of usage options as available in the command line arguments

Returns:

If any of the mandatory options is missing

findUsageToken

public UsageToken findUsageToken(String option)

Parameters:

option - The option as present in the usage expression, e.g. m in usage expression -m minute [-s seconds] is an option

Returns:

Corresponding usage token

Throws:

IllegalArgumentException - If corresponding usage token could not be found

noTokensAvailable

public boolean noTokensAvailable()

Returns:

If no valid usage tokens could be found in the given usage expression

getSetterMethod

public Method getSetterMethod(UsageToken usageToken)

Parameters:

usageToken - The usage token corresponding to the option

Returns:

The setter method in specified data class corresponding to given usage token