jargs.gnu

## Class CmdLineParser.Option.StringOption

- java.lang.Object
- - jargs.gnu.CmdLineParser.Option
  - - jargs.gnu.CmdLineParser.Option.StringOption

- All Implemented Interfaces:
    Serializable
  Enclosing class:
    CmdLineParser.Option

      public static class CmdLineParser.Option.StringOption
      extends CmdLineParser.Option

  An option that expects a string value.
  See Also:
    Serialized Form

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class jargs.gnu.CmdLineParser.Option

      `CmdLineParser.Option.BooleanOption, CmdLineParser.Option.DoubleOption, CmdLineParser.Option.IntegerOption, CmdLineParser.Option.LongOption, CmdLineParser.Option.StringOption`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `StringOption(char shortForm, String longForm)` Instantiates a new string option.
    `StringOption(String longForm)` Instantiates a new string option.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected Object` | `parseValue(String arg, Locale locale)` Override to extract and convert an option value passed on the command-line.

    - ### Methods inherited from class jargs.gnu.CmdLineParser.Option

      `getValue, longForm, shortForm, wantsValue`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### StringOption

          public StringOption(char shortForm,
                              String longForm)

      Instantiates a new string option.
      Parameters:
        `shortForm` - the short form
        `longForm` - the long form

    - #### StringOption

          public StringOption(String longForm)

      Instantiates a new string option.
      Parameters:
        `longForm` - the long form

  - ### Method Detail

    - #### parseValue

          protected Object parseValue(String arg,
                                      Locale locale)

      Description copied from class: `CmdLineParser.Option`
      Override to extract and convert an option value passed on the command-line.
      Overrides:
        `parseValue` in class `CmdLineParser.Option`
      Parameters:
        `arg` - the arg
        `locale` - the locale
      Returns:
        the object

Copyright © 2009–2020 Jeremy Landis. All rights reserved.