marf.util
Interface IOptionProvider

All Known Implementing Classes:

OptionFileLoader, OptionProcessor

public interface IOptionProvider

Anything that provides an options set to option consumers must conform to this SIMPLE interface.

$Id: IOptionProvider.java,v 1.1 2006/05/28 04:28:18 mokhov Exp $ $MARF$

Since:

0.3.0.6

Version:

$Revision: 1.1 $

Author:

Serguei Mokhov

Method Summary

void	addActiveOption(int piOptionCode, java.lang.String pstrOptionString)
void	addActiveOption(java.lang.String pstrOptionString)
void	addActiveOption(java.lang.String pstrOptionString, java.lang.String pstrOptionValue)
void	addValidOption(int piOptionCode, java.lang.String pstrOptionString)
void	addValidOption(int piOptionCode, java.lang.String pstrOptionString, boolean pbRequiresArgument)
void	addValidOption(java.lang.String pstrOptionString)
java.util.Hashtable	getActiveOptions()
java.lang.String	getArgumentString()
java.lang.String[]	getArgumentVector()
java.util.Vector	getInvalidOptions()
java.lang.String	getOption(int piOption)
java.lang.String	getOption(int piOption, boolean pbReturnOnError)
int	getOption(java.lang.String pstrOption)
int	getOption(java.lang.String pstrOption, boolean pbReturnOnError)
java.lang.String	getOptionArgument(int piOption)
java.lang.String	getOptionArgument(int piOption, boolean pbReturnOnError)
java.lang.String	getOptionArgument(java.lang.String pstrOption)
java.lang.String	getOptionArgument(java.lang.String pstrOption, boolean pbReturnOnError)
java.util.Hashtable	getValidOptions()
boolean	isActiveOption(int piOption)
boolean	isActiveOption(java.lang.String pstrOption)
boolean	isInvalidOption(java.lang.String pstrOption)
boolean	isValidOption(int piOption)
boolean	isValidOption(java.lang.String pstrOption)
int	size()

Method Detail

addValidOption

void addValidOption(java.lang.String pstrOptionString)

addValidOption

void addValidOption(int piOptionCode,
                    java.lang.String pstrOptionString)

addValidOption

void addValidOption(int piOptionCode,
                    java.lang.String pstrOptionString,
                    boolean pbRequiresArgument)

addActiveOption

void addActiveOption(java.lang.String pstrOptionString)

addActiveOption

void addActiveOption(java.lang.String pstrOptionString,
                     java.lang.String pstrOptionValue)

addActiveOption

void addActiveOption(int piOptionCode,
                     java.lang.String pstrOptionString)

size

int size()

getArgumentVector

java.lang.String[] getArgumentVector()

getArgumentString

java.lang.String getArgumentString()

getOption

int getOption(java.lang.String pstrOption)

getOption

int getOption(java.lang.String pstrOption,
              boolean pbReturnOnError)

getOption

java.lang.String getOption(int piOption)

getOption

java.lang.String getOption(int piOption,
                           boolean pbReturnOnError)

getOptionArgument

java.lang.String getOptionArgument(java.lang.String pstrOption)

getOptionArgument

java.lang.String getOptionArgument(java.lang.String pstrOption,
                                   boolean pbReturnOnError)

getOptionArgument

java.lang.String getOptionArgument(int piOption)

getOptionArgument

java.lang.String getOptionArgument(int piOption,
                                   boolean pbReturnOnError)

getInvalidOptions

java.util.Vector getInvalidOptions()

getActiveOptions

java.util.Hashtable getActiveOptions()

getValidOptions

java.util.Hashtable getValidOptions()

isActiveOption

boolean isActiveOption(java.lang.String pstrOption)

isActiveOption

boolean isActiveOption(int piOption)

isValidOption

boolean isValidOption(java.lang.String pstrOption)

isValidOption

boolean isValidOption(int piOption)

isInvalidOption

boolean isInvalidOption(java.lang.String pstrOption)