Class ArgumentHelper


  • public class ArgumentHelper
    extends java.lang.Object
    Utility class to assist in extracting program arguments.
    Since:
    V2.1-A
    Author:
    Derek Hulley
    • Constructor Summary

      Constructors 
      Constructor Description
      ArgumentHelper​(java.lang.String usage, java.lang.String[] args)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getIntegerValue​(java.lang.String arg, boolean mandatory, int minValue, int maxValue)  
      java.lang.String getStringValue​(java.lang.String arg, boolean mandatory, boolean nonEmpty)  
      void printUsage()  
      static java.util.Map<java.lang.String,​java.lang.String> ripArgs​(java.lang.String... args)  
      • Methods inherited from class java.lang.Object

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

      • ArgumentHelper

        public ArgumentHelper​(java.lang.String usage,
                              java.lang.String[] args)
    • Method Detail

      • ripArgs

        public static java.util.Map<java.lang.String,​java.lang.String> ripArgs​(java.lang.String... args)
      • getStringValue

        public java.lang.String getStringValue​(java.lang.String arg,
                                               boolean mandatory,
                                               boolean nonEmpty)
        Throws:
        java.lang.IllegalArgumentException - if the argument doesn't match the requirements.
      • getIntegerValue

        public int getIntegerValue​(java.lang.String arg,
                                   boolean mandatory,
                                   int minValue,
                                   int maxValue)
        Returns:
        Returns the value assigned or the minimum value if the parameter was not present
        Throws:
        java.lang.IllegalArgumentException - if the argument doesn't match the requirements.
      • printUsage

        public void printUsage()