Class CmdLine


  • public class CmdLine
    extends java.lang.Object
    Class CmdLine represents a parsed command line for one run of a program.
    Author:
    David Ripton
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.ArrayList<java.lang.String> leftovers  
      private java.util.Set<java.lang.String> nameSeen  
      private java.util.Map<java.lang.String,​java.lang.String> nameToValue  
      private java.util.Set<java.lang.Character> optchSeen  
      private java.util.Map<java.lang.Character,​java.lang.String> optchToValue  
    • Constructor Summary

      Constructors 
      Constructor Description
      CmdLine​(Opts opts, java.lang.String[] args)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.ArrayList<java.lang.String> getLeftovers()
      Return an ArrayList of all leftover arguments that were found on the command line after valid options were parsed.
      java.lang.String getOptValue​(char optch)
      Return the option value as a String.
      java.lang.String getOptValue​(java.lang.String name)
      Return the option value as a String.
      boolean optIsSet​(char optch)
      Return true iff the option has been seen.
      boolean optIsSet​(java.lang.String name)
      Return true iff the option has been seen.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • leftovers

        private final java.util.ArrayList<java.lang.String> leftovers
      • optchToValue

        private final java.util.Map<java.lang.Character,​java.lang.String> optchToValue
      • nameToValue

        private final java.util.Map<java.lang.String,​java.lang.String> nameToValue
      • optchSeen

        private final java.util.Set<java.lang.Character> optchSeen
      • nameSeen

        private final java.util.Set<java.lang.String> nameSeen
    • Constructor Detail

      • CmdLine

        public CmdLine​(Opts opts,
                       java.lang.String[] args)
    • Method Detail

      • optIsSet

        public boolean optIsSet​(char optch)
        Return true iff the option has been seen.
      • optIsSet

        public boolean optIsSet​(java.lang.String name)
        Return true iff the option has been seen.
      • getOptValue

        public java.lang.String getOptValue​(char optch)
        Return the option value as a String. Will raise if the option has not been set or does not take an argument.
      • getOptValue

        public java.lang.String getOptValue​(java.lang.String name)
        Return the option value as a String. Will raise if the option has not been set or does not take an argument.
      • getLeftovers

        public java.util.ArrayList<java.lang.String> getLeftovers()
        Return an ArrayList of all leftover arguments that were found on the command line after valid options were parsed.