Module org.tquadrat.foundation.config
Package org.tquadrat.foundation.config.cli

Class BooleanValueHandler

java.lang.Object
org.tquadrat.foundation.config.cli.CmdLineValueHandler<Boolean>
org.tquadrat.foundation.config.cli.BooleanValueHandler
@ClassVersion(sourceVersion="$Id: BooleanValueHandler.java 1061 2023-09-25 16:32:43Z tquadrat $") @API(status=STABLE, since="0.0.1") public class BooleanValueHandler extends CmdLineValueHandler<Boolean>
An implementation of CmdLineValueHandler for boolean and Boolean values.
Author:
Kohsuke Kawaguchi (kk@kohsuke.org)
Modified by:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: BooleanValueHandler.java 1061 2023-09-25 16:32:43Z tquadrat $
Since:
0.0.1
UML Diagram
UML Diagram for "org.tquadrat.foundation.config.cli.BooleanValueHandler"⁠

UML Diagram for "org.tquadrat.foundation.config.cli.BooleanValueHandler"

UML Diagram for "org.tquadrat.foundation.config.cli.BooleanValueHandler"⁠

  • Constructor Details

    • BooleanValueHandler

      public BooleanValueHandler(CLIDefinition context, BiConsumer<String,Boolean> valueSetter)
      Creates a new BooleanValueHandler instance.
      Parameters:
      context - The CLI definition that provides the context for this value handler.
      valueSetter - The function that places the translated value to the property.

    • BooleanValueHandler

      public BooleanValueHandler(BiConsumer<String,Boolean> valueSetter)
      Creates a new BooleanValueHandler instance.
      Parameters:
      valueSetter - The function that places the translated value to the property.

  • Method Details

    • parseCmdLine

      public int parseCmdLine(Parameters params)
      Parses the given command line snippet and stores the result to the property.
      Overrides:
      parseCmdLine in class CmdLineValueHandler<Boolean>
      Parameters:
      params - The command line values to parse.
      Returns:
      The number of values that the method took from the command line.

    • translate

      protected Collection<Boolean> translate(Parameters params) throws CmdLineException
      Translates the command line values that can be referenced via the params argument to the target type.
      Specified by:
      translate in class CmdLineValueHandler<Boolean>
      Parameters:
      params - The command line values to translate.
      Returns:
      A collection with the result; each entry in the collection corresponds to one value from the command line.
      Throws:
      CmdLineException - The given parameters cannot be parsed to the target type.