org.yuanheng.cookcc.interfaces

Interface OptionHandler

All Known Implementing Classes:

AbstractOption, ClassOption, OutputDirectoryOption, OutputOption

public interface OptionHandler

OptionParser is used in parsing user command line arguments. It's toString () function is used to print usage.

Version:

$Id: OptionHandler.java 482 2008-11-09 12:18:31Z superduperhengyuan $

Author:

Heng Yuan

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOption() Indicates the option string
void	handleOption(java.lang.String value) This function parses the argument at the current index.
boolean	requireArguments() Indicates whether or not this option requires an argument.

Method Detail

getOption

java.lang.String getOption()

Indicates the option string

Returns:

the option string

requireArguments

boolean requireArguments()

Indicates whether or not this option requires an argument.

Returns:

whether or not this option requires an argument.

handleOption

void handleOption(java.lang.String value)
           throws java.lang.Exception

This function parses the argument at the current index. If this function recognizes the argument, it would return the number of arguments being read. Otherwise, just return 0 to indicate that it was not handled.

Parameters:

value - the argument for the option

Throws:

java.lang.Exception - in case of error.