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))
  • package config

    This package provides various configuration sources under a common trait Config, which is basically an immutable map.

    This package provides various configuration sources under a common trait Config, which is basically an immutable map. The following implementations are available:

    - ArgsConfig loads key/value pairs from an array of strings: array elements that contain a separator char (defined by ArgsConfig.SeparatorChar) are considered as key/value pairs, while elements not consumed by this rule can be retrieved by the remaining array (makes it suitable to scan a command line for such key/value pairs and parsing the rest with tools like described in [U1 Command-Line Interface](#u1-command-line-interface).

    - FileConfig loads key/value pairs from a specified resource file which must conform to the java.util.Properties#load(InputStream) method; there is also a factory method where the resource is looked up under the modified package name of a specified class.

    - BundleConfig loads key/value pairs from a resource bundle (according to the java.util.ResourceBundle class) of a specified base name using a locale option; there is also a factory method where the resource bundle is looked up under the modified package name of a specified class.

    * SystemPropertiesConfig is a Config object that represents the system properties of the JVM.

    * SystemEnvironmentConfig is a Config object that represents the system environment; note that the system may not support environment variables -- in this case, this object is empty.

    Multiple Configs can be combined using the standard map ++ operators, yielding an overall Config.

    Definition Classes
    util
    Example:

    1. import de.h2b.scala.lib.util.config._
val argsConfig = ArgsConfig("-x key1=val1 /y key2=val2 abc".split(' '))
val sysConfig = SystemPropertiesConfig
val otherConfig = Config("one"->1, "two"->2, "three"->3)
val config = argsConfig ++ sysConfig ++ otherConfig
println(config.get("key1")) //> Some(val1)
println(config.get("java.version")) //> Some(1.8.0_121)
println(config.get("two")) //> Some(2)
println(argsConfig.remaining.mkString(" ")) //> -x /y abc
  • ArgsConfig
  • BundleConfig
  • Config
  • ConfigFactory
  • FileConfig
  • SystemEnvironmentConfig
  • SystemPropertiesConfig

package config

This package provides various configuration sources under a common trait Config, which is basically an immutable map. The following implementations are available:

- ArgsConfig loads key/value pairs from an array of strings: array elements that contain a separator char (defined by ArgsConfig.SeparatorChar) are considered as key/value pairs, while elements not consumed by this rule can be retrieved by the remaining array (makes it suitable to scan a command line for such key/value pairs and parsing the rest with tools like described in [U1 Command-Line Interface](#u1-command-line-interface).

- FileConfig loads key/value pairs from a specified resource file which must conform to the java.util.Properties#load(InputStream) method; there is also a factory method where the resource is looked up under the modified package name of a specified class.

- BundleConfig loads key/value pairs from a resource bundle (according to the java.util.ResourceBundle class) of a specified base name using a locale option; there is also a factory method where the resource bundle is looked up under the modified package name of a specified class.

* SystemPropertiesConfig is a Config object that represents the system properties of the JVM.

* SystemEnvironmentConfig is a Config object that represents the system environment; note that the system may not support environment variables -- in this case, this object is empty.

Multiple Configs can be combined using the standard map ++ operators, yielding an overall Config.

Example:

  1. import de.h2b.scala.lib.util.config._
val argsConfig = ArgsConfig("-x key1=val1 /y key2=val2 abc".split(' '))
val sysConfig = SystemPropertiesConfig
val otherConfig = Config("one"->1, "two"->2, "three"->3)
val config = argsConfig ++ sysConfig ++ otherConfig
println(config.get("key1")) //> Some(val1)
println(config.get("java.version")) //> Some(1.8.0_121)
println(config.get("two")) //> Some(2)
println(argsConfig.remaining.mkString(" ")) //> -x /y abc
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. config
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class ArgsConfig extends Config[String, String]

    A Config that loads key/value pairs from an args array.

    A Config that loads key/value pairs from an args array.

    Only elements that contain a separator char (defined by ArgsConfig.SeparatorChar) are considered as a key/value pair. The substring before the first separator char is the key, everything after it is the value (even if contains more separator chars).

    Elements not consumed by this rule can be retrieved by the remaining array.

    Note

    According to the rule, one or both parts of a key/value pair may be the empty string.

  2. class BundleConfig extends Config[String, String]

    A Config that loads key/value pairs from a resource bundle

    A Config that loads key/value pairs from a resource bundle

    Note

    The base name must identify a resource bundle according to the java.util.ResourceBundle class.

    ,

    All values must be strings.

    ,

    If some I/O or other exception occurs when loading the bundle, the resulting Config is empty.

  3. trait Config[Key, +Value] extends Map[Key, Value] with MapOps[Key, Value, Config, Config[Key, Value]] with MapFactoryDefaults[Key, Value, Config, Iterable]

    An immutable type that provides configuration properties as a map of key/value pairs.

    An immutable type that provides configuration properties as a map of key/value pairs.

    Note

    This variant of the source code is for Scala from version 2.13 on.

  4. class ConfigFactory extends MapFactory[Config]
  5. class FileConfig extends Config[String, String]

    A Config that loads key/value pairs from a single properties file.

    A Config that loads key/value pairs from a single properties file.

    Note

    The content of the file must conform to the java.util.Properties#load(InputStream) method.

    ,

    If some I/O or other exception occurs when loading the file, the resulting Config is empty.

Value Members

  1. object ArgsConfig
  2. object BundleConfig
  3. object Config
  4. object FileConfig
  5. object SystemEnvironmentConfig extends Config[String, String]

    A Config that represents the system environment.

    A Config that represents the system environment.

    Note

    The system may not support environment variables. In this case, this config object is empty.

    ,

    If a security manager exists and doesn't allow access to the process environment, this config object is empty.

  6. object SystemPropertiesConfig extends Config[String, String]

    A Config that represents the system properties of the JVM.

    A Config that represents the system properties of the JVM.

    Note

    If a security manager exists and doesn't allow access to the system properties, this config object is empty.

Inherited from AnyRef

Inherited from Any

Ungrouped