Module org.tquadrat.foundation.config
Package org.tquadrat.foundation.config.internal

Class ArgumentParser

java.lang.Object
org.tquadrat.foundation.config.internal.ArgumentParser
@ClassVersion(sourceVersion="$Id: ArgumentParser.java 1120 2024-03-16 09:48:00Z tquadrat $") @API(status=INTERNAL, since="0.0.1") public class ArgumentParser extends Object
The parser for the command line arguments.
Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: ArgumentParser.java 1120 2024-03-16 09:48:00Z tquadrat $
Since:
0.0.1
UML Diagram
UML Diagram for "org.tquadrat.foundation.config.internal.ArgumentParser"⁠

UML Diagram for "org.tquadrat.foundation.config.internal.ArgumentParser"

UML Diagram for "org.tquadrat.foundation.config.internal.ArgumentParser"⁠

  • Field Details

  • Constructor Details

    • ArgumentParser

      public ArgumentParser(Collection<? extends CLIDefinition> cliDefinitions)
      Creates a new ArgumentParser instance.
      Parameters:
      cliDefinitions - The definition for the command line options and arguments from the configuration bean specification.

  • Method Details

    • addArgument

      private final void addArgument(CLIDefinition definition)
      Adds an argument definition to the registry for arguments.
      Parameters:
      definition - The argument definition to add.

    • addOption

      private final void addOption(CLIDefinition definition)
      Adds an option definition to the registry for options.
      Parameters:
      definition - The option definition to add.

    • findOptionDefinition

      private final CLIOptionDefinition findOptionDefinition(String name)
      Finds an option definition by the given option name.
      Parameters:
      name - The option name.
      Returns:
      The option definition.
      Throws:
      CmdLineException - There is no option definition for the given option name.

    • getCurrentOptionDefinition

      final CLIOptionDefinition getCurrentOptionDefinition()
      Returns the current CLI option definition.
      Returns:
      The current CLI option definition.

    • getOptionName

      final String getOptionName()
      Returns the name of the option that is being processed currently.
      Returns:
      The name of the current option.

    • isOption

      private final boolean isOption(String token)
      Checks if the given token is an option (as opposed to an argument). Option tokens will have a hyphen ("-") as their first character.
      Parameters:
      token - The token to test.
      Returns:
      true if the given token is an option, false if it is an argument, or if no (more) options are expected at all.
      See Also:

    • checkOptionNotYetUsed

      private final void checkOptionNotYetUsed(String name) throws IllegalArgumentException
      Checks the command line definition whether the given name is not yet used, either as a name or an alias.
      Parameters:
      name - The name to check.
      Throws:
      IllegalArgumentException - The given name is already in use.

    • parse

      public final void parse(String... args) throws CmdLineException
      Parses the given command line arguments and sets the retrieved values to the configuration bean.
      Parameters:
      args - The command line arguments to parse.
      Throws:
      CmdLineException - An error occurred while parsing the arguments or a mandatory option or argument is missing on the command line.

    • parsingOptions

      public final boolean parsingOptions()
      Returns true if this ArgumentParser will parse options. This can be set to false either when no @Option annotation was found on the configuration bean specification interface, when the stop token ("--") was encountered on the command line, or when stopOptionParsing() was called manually.
      Returns:
      true when options are parsed, false if not.
      See Also:

    • resolveCommandLine

      public final String resolveCommandLine(String... args)

      Resolves the given command line.

      The method is mainly meant for test and debugging purposes.

      Parameters:
      args - The command line arguments.
      Returns:
      The resolved command line as a single String.

    • stopOptionParsing

      public final void stopOptionParsing()
      Stops the parsing for options. After the call, the argument list will be parsed only for arguments.