com.vmware.apputils
Class OptionSpec

java.lang.Object
  com.vmware.apputils.OptionSpec

public class OptionSpec
extends java.lang.Object

The OptionSpec class is the basis for all command-line arguments that get passed to the sample applications. All sample applications use several basic command-line options defined as instances of this class. Use this class to define your own custom options for use with applications that you create that use the helper classes in the com.vmware.apputils package.

Constructor Summary

OptionSpec(java.lang.String optionName, java.lang.String optionType, int optionRequired, java.lang.String optionDesc, java.lang.String optionDefault)

Method Summary

java.lang.String	getOptionDefault()
java.lang.String	getOptionDesc()
java.lang.String	getOptionName()
int	getOptionRequired()
java.lang.String	getOptionType()

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionSpec

public OptionSpec(java.lang.String optionName,
                  java.lang.String optionType,
                  int optionRequired,
                  java.lang.String optionDesc,
                  java.lang.String optionDefault)

Parameters:

optionName - Unique string to specify the command-line argument.

optionType - Datatype for the option, such as "string."

optionRequired - Integer that specifies if the option is required (1), or not (0).

optionDesc - Brief description of the option and its use.

optionDefault - Default value of the option, if one exists. Can be null.

Method Detail

getOptionName

public java.lang.String getOptionName()

getOptionRequired

public int getOptionRequired()

getOptionDesc

public java.lang.String getOptionDesc()

getOptionType

public java.lang.String getOptionType()

getOptionDefault

public java.lang.String getOptionDefault()