Uses of Class
com.martiansoftware.jsap.Parameter

Packages that use Parameter
Package
Description
com.martiansoftware.jsap
 
com.martiansoftware.jsap.ant
 

  • Uses of Parameter in com.martiansoftware.jsap

    Subclasses of Parameter in com.martiansoftware.jsap
    Modifier and Type
    Class
    Description
    class 
    FlaggedOption
    An option that implements the Flagged interface.
    class 
    Option
    The base class from which FlaggedOption and UnflaggedOption are derived.
    final class 
    QualifiedSwitch
    A QualifiedSwitch is a parameter that has something in common with a Switch, i.e., its presence or absence is significant, but different from a "pure" Switch it can have an additional value (or values) prefixed by a ':' sign that qualifies the Switch - making it behave like a FlaggedOption if a value is specified.
    class 
    Switch
    A Switch is a parameter whose presence alone is significant; another commonly used term for a Switch is "Flag".
    final class 
    UnflaggedOption
    An option whose meaning is derived from its position in the argument list rather than a flag that precedes it.
    Methods in com.martiansoftware.jsap that return Parameter
    Modifier and Type
    Method
    Description
    Parameter
    JSAP.getByID(String id)
    Returns the requested Switch, FlaggedOption, or UnflaggedOption with the specified ID.
    final Parameter
    Parameter.setHelp(String help)
    Sets the help text for this parameter.
    Methods in com.martiansoftware.jsap with parameters of type Parameter
    Modifier and Type
    Method
    Description
    void
    JSAP.registerParameter(Parameter param)
    Registers the specified Parameter (i.e., Switch, FlaggedOption, or UnflaggedOption) with this JSAP.
    void
    JSAP.unregisterParameter(Parameter param)
    Unregisters the specified Parameter (i.e., Switch, FlaggedOption, or UnflaggedOption) from this JSAP.
    Constructors in com.martiansoftware.jsap with parameters of type Parameter
    Modifier
    Constructor
    Description
     
    SimpleJSAP(String name, String explanation, Parameter[] parameter)
    Creates a new simple JSAP with default screen width.

  • Uses of Parameter in com.martiansoftware.jsap.ant

    Methods in com.martiansoftware.jsap.ant that return Parameter
    Modifier and Type
    Method
    Description
    Parameter
    FlaggedOptionConfiguration.getParameter()
    Returns a FlaggedOption preconfigured according to this configuration.
    abstract Parameter
    ParameterConfiguration.getParameter()
    Returns an Parameter (String, FlaggedOption, or UnflaggedOption) configured according to the settings contained within this object.
    Parameter
    SwitchConfiguration.getParameter()
    Returns a Switch configured according to this configuration.
    Parameter
    UnflaggedOptionConfiguration.getParameter()
    Returns an UnflaggedOption configured according to this configuration.