Package

com.fulcrumgenomics.sopt

parsing

Permalink

package parsing

Visibility
  1. Public
  2. All

Type Members

  1. case class ArgOptionAndValues(name: String, values: Seq[String]) extends Product with Serializable

    Permalink
  2. class ArgTokenCollator extends Iterator[Try[ArgOptionAndValues]]

    Permalink

    Collates Tokens into name and values, such that there is no value without an associated option name.

  3. class ArgTokenizer extends Iterator[Try[Token]]

    Permalink

    A class to tokenize a sequence of strings prior to option parsing.

    A class to tokenize a sequence of strings prior to option parsing. A series of tokens will be available. If any errors are encountered, a failure will be present instead of the token.

  4. case class DuplicateOptionNameException(message: String) extends OptionParsingException with Product with Serializable

    Permalink

    For errors when the same option name is given for different options

  5. case class IllegalFlagValueException(message: String) extends OptionParsingException with Product with Serializable

    Permalink

    For errors when parsing the value for a flag field

  6. case class IllegalOptionNameException(message: String) extends OptionParsingException with Product with Serializable

    Permalink

    For errors when the same option name is not found

  7. trait OptionLookup extends AnyRef

    Permalink

    Stores information about the option specifications and their associated values

  8. case class OptionNameException(message: String) extends OptionParsingException with Product with Serializable

    Permalink

    For errors in specifying the option name, for example missing leading dashes, nothing after the leading dashes, ...

  9. class OptionParser extends OptionLookup with Traversable[(OptionName, List[OptionValue])]

    Permalink

    Very simple command line parser.

    Very simple command line parser.

    1. Option specifications should be specified using methods in OptionLookup: OptionLookup.acceptFlag(), OptionLookup.acceptSingleValue(), OptionLookup.acceptMultipleValues(). 2. Call parse() to parse the argument strings. 3. Either (1) Query for option values in OptionLookup: OptionLookup.hasOptionValues and OptionLookup.optionValues(), or (2) traverse tuples of name and values using OptionParser().foreach() or similar methods.

    See the README.md for more information on valid arguments to OptionParser.

  10. sealed abstract class OptionParsingException extends RuntimeException

    Permalink

    Exception classes for various option parsing errors

  11. case class OptionSpecifiedMultipleTimesException(message: String) extends OptionParsingException with Product with Serializable

    Permalink

    For errors when specifying an option too many times

  12. case class TooFewValuesException(message: String) extends OptionParsingException with Product with Serializable

    Permalink

    For errors when specifying too few values for an option

  13. case class TooManyValuesException(message: String) extends OptionParsingException with Product with Serializable

    Permalink

    For errors when specifying too many values for an option

Value Members

  1. object ArgTokenCollator

    Permalink
  2. object ArgTokenizer

    Permalink
  3. object OptionLookup

    Permalink

    Helper methods for looking up options, including their names, types, and values

    Helper methods for looking up options, including their names, types, and values

    Attributes
    protected

Ungrouped