Packages

•  package root

  Definition Classes

  root

•  package de

  Definition Classes

  root

•  package h2b

  Definition Classes

  de

•  package scala

  Definition Classes

  h2b

•  package lib

  Definition Classes

  scala

•  package util

  This is a Scala library of programming utilities.

  This is a Scala library of programming utilities. It is not intended to comprise a systematic collection but contains some tools that may be useful for some applications.

  Some highlights are a number of probability distributions, a command-line interface, a configuration package, an RSS utility, a class to handle temporary directories, control structures, a logger trait and a timer.

  Definition Classes

  lib

•  package cli

  Define the parameters of your command line as instances of

  Define the parameters of your command line as instances of

  - FlagParameter: no specific value, just signals that it is there,

  - HelpParameter: signals that the user needs some help (if given as a command-line argument, other parameters are not computed and no parse exceptions are thrown),

  - ValueParameter[V]: has exactly one value of type V,

  - ListParameter[V]: has a number of values of type V and

  - MainParameter: has a number of String values.

  ValueParameter[V] and ListParameter[V] need a converter to convert a string to the value type V. You might want to import the object Converter that provides converters for standard data types implicitly by:

  import de.h2b.scala.lib.util.cli.Converter._

  Then create a new instance of CommandLine with a set of parameters. The resulting object then can parse a string sequence or an array of strings for parameters and their values. If something goes wrong, either a ParameterException (some argument does not obey to the format specified by its parameter) or a CommandLineException (something is wrong with the arguments as a whole) is thrown.

  Finally query the original parameter instances for its value or values field.

  The usage method of CommandLine constructs a string suitable for a usage message.

  Definition Classes

  util

  Example:

  1. import de.h2b.scala.lib.util.cli._
     import de.h2b.scala.lib.util.cli.Converter._
     val overwrite = FlagParameter(Set("-o", "--overwrite"), "overwrite target")
     val mode = ValueParameter(Set("-m"), "mode", default=Some(0))
     val main = MainParameter("source target", arity=2)
     CommandLine(Set(overwrite, mode, main)).parse("-o -m 1 from to".split(' '))
     println(overwrite.value) //> Some(true)
     println(mode.value) //> Some(1)
     println(main.values) //> Some(WrappedArray(from, to))

• CommandLine
• CommandLineException
• Converter
• FlagParameter
• HelpParameter
• ListParameter
• MainParameter
• MultipleValues
• Parameter
• ParameterException
• SingleValue
• ValueParameter

de.h2b.scala.lib.util.cli

ListParameter