Class CommandLineTool


  • public class CommandLineTool
    extends java.lang.Object
    Access class for the Command Line Interface
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String KEY_HELP  
    • Constructor Summary

      Constructors 
      Constructor Description
      CommandLineTool()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void main​(java.lang.String[] args)  
      static void printHelp​(java.lang.String modelName, joptsimple.OptionParser toPrint)  
      static boolean printHelpIfRequested​(joptsimple.OptionSet generalOptions, Model model, joptsimple.OptionParser toPrint)
      Prints help if requested.
      • Methods inherited from class java.lang.Object

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

      • KEY_HELP

        public static java.lang.String KEY_HELP
    • Constructor Detail

      • CommandLineTool

        public CommandLineTool()
    • Method Detail

      • main

        public static void main​(java.lang.String[] args)
                         throws java.io.IOException
        Throws:
        java.io.IOException
      • printHelpIfRequested

        public static boolean printHelpIfRequested​(joptsimple.OptionSet generalOptions,
                                                   Model model,
                                                   joptsimple.OptionParser toPrint)
        Prints help if requested. Returns if help was printed
        Parameters:
        generalOptions - all options
        model - optional - model for which help has to be printed
        toPrint -
        Returns:
        true iff help was printed
      • printHelp

        public static void printHelp​(java.lang.String modelName,
                                     joptsimple.OptionParser toPrint)