Class AbstractCommand<T extends GlobalArguments>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected T arguments  
      protected ch.systemsx.cisd.args4j.CmdLineParser parser  
    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractCommand​(T arguments)  
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      T getArguments()  
      protected java.lang.String getCommandCallString()
      How is this command invoked from the command line? This is the program call string + command name
      ch.systemsx.cisd.args4j.CmdLineParser getParser()  
      protected abstract java.lang.String getProgramCallString()
      How is this program invoked from the command line?
      protected abstract java.lang.String getRequiredArgumentsString()
      What are the required arguments?
      protected java.lang.String getUsagePrefixString()
      Used for displaying help.
      void printUsage​(java.io.PrintStream out)
      Print usage information about the command.
      • Methods inherited from class java.lang.Object

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

      • parser

        protected final ch.systemsx.cisd.args4j.CmdLineParser parser
    • Constructor Detail

      • AbstractCommand

        public AbstractCommand​(T arguments)
    • Method Detail

      • printUsage

        public void printUsage​(java.io.PrintStream out)
        Print usage information about the command.
        Specified by:
        printUsage in interface ICommand
        Parameters:
        out - The stream to which help is printed
      • getParser

        public ch.systemsx.cisd.args4j.CmdLineParser getParser()
      • getArguments

        public T getArguments()
      • getUsagePrefixString

        protected java.lang.String getUsagePrefixString()
        Used for displaying help.
      • getCommandCallString

        protected java.lang.String getCommandCallString()
        How is this command invoked from the command line? This is the program call string + command name
      • getProgramCallString

        protected abstract java.lang.String getProgramCallString()
        How is this program invoked from the command line?
      • getRequiredArgumentsString

        protected abstract java.lang.String getRequiredArgumentsString()
        What are the required arguments?