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

Class ArgumentParser.CmdLineImpl

java.lang.Object
org.tquadrat.foundation.config.internal.ArgumentParser.CmdLineImpl
All Implemented Interfaces:
Iterator<String>, Parameters
Enclosing class:
ArgumentParser
@ClassVersion(sourceVersion="$Id: ArgumentParser.java 1120 2024-03-16 09:48:00Z tquadrat $") @API(status=INTERNAL, since="0.0.1") private final class ArgumentParser.CmdLineImpl extends Object implements Iterator<String>, Parameters

This class is essentially a pointer over the String array with the command line arguments. It can move forward, and it can look ahead.

But it will also resolve the references to argument files, and it will translate single letter options without blanks between option and value into two entries, as well as long entries where an equal sign is used.

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.CmdLineImpl"⁠

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

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

  • Field Details

  • Constructor Details

    • CmdLineImpl

      public CmdLineImpl(String... args)
      Creates a new object for CmdLineImpl.
      Parameters:
      args - The arguments list.

  • Method Details

    • getCurrentToken

      public final String getCurrentToken()
      Returns the current token from the arguments list.
      Returns:
      The current token.

    • getParameter

      public final String getParameter(int index) throws CmdLineException

      Returns the additional parameter to a related option.

      Specifying 0 for index will retrieve the token next to the option. For example, if the command line looks like

      -o abc -d x

      then getParameter(0) for the option "-o" returns "abc"; getParameter(1) would return "-d", but as this is an option, a CmdLineException will be thrown instead.

      Specified by:
      getParameter in interface Parameters
      Parameters:
      index - The index for the requested parameter; must be 0 or greater.
      Returns:
      The requested parameter.
      Throws:
      CmdLineException - An attempt is made to access a non-existent index, or the index is for a non-parameter entry on the command line.

    • hasNext

      public final boolean hasNext()
      Checks if there are more entries.
      Specified by:
      hasNext in interface Iterator<String>
      Returns:
      true if there are more entries, false otherwise.

    • isParameter

      public final boolean isParameter(int index) throws CmdLineException

      Tests whether the given index is for an additional parameter to a related option. The first additional parameter has the index 0, a second one will have 1 and so on.

      Assume the command line looks like this:

      -o abc def -d x

      Then isParameter(0) and isParameter(1) would return true, but isParameter(3) returns false: x is an additional parameter, but for the option -d in this case.

      Specified by:
      isParameter in interface Parameters
      Parameters:
      index - The index for the requested parameter; must be 0 or greater.
      Returns:
      true if the argument at the given location is an additional parameter for the current option, false if not.
      Throws:
      CmdLineException

    • loadArgumentFile

      private final Collection<String> loadArgumentFile(String arg, Collection<String> failedFiles)

      Loads an argument file as specified by the given argument and returns the contents of that file as additional command line arguments.

      If no file could be retrieved for the name given with the argument, that argument will be added to the list of failed files and the unchanged argument will be returned.

      Variables of the form ${<name>} will be replaced by the value for name from the system properties (System.getProperty(String)).

      Lines that starts with "#" are comments; if an argument has to start with "#", it has to be escaped with "\#".

      Parameters:
      arg - The command line argument.
      failedFiles - The list of failed files.
      Returns:
      The additional command line arguments as read from the file, if it could be opened.

    • next

      public final String next() throws NoSuchElementException
      Specified by:
      next in interface Iterator<String>
      Throws:
      NoSuchElementException

    • proceed

      public final void proceed(int n)
      Skip the given number of entries.
      Parameters:
      n - The number of entries to skip; must be greater 0.

    • putback

      public final void putback(String part1, String part2)
      In case the entry is a combination from option and the related parameter (like --arg value or, for single character options, -p value), this method is used to put it back to the command line.
      Parameters:
      part1 - The first part, usually the option.
      part2 - The second part, usually the value.