Method Detail

• getOutputStream

  public java.io.PrintStream getOutputStream​()

  Get an output stream to which data may be sent.

  Returns:

  stream to write to

• getErrorStream

  public java.io.PrintStream getErrorStream​()

  Get an output stream to which error messages may be sent.

  Returns:

  stream to write to

• getCurrentDirectory

  public java.io.File getCurrentDirectory​()

  The directory relative file operations shall be relative to. Can be specified while starting the parse of CommandLine.

  Returns:

  file representing current directory

• getInputStream

  public java.io.InputStream getInputStream​()

  Get an input stream that may supply additional data.

  Returns:

  stream to read from

• usage

  public void usage​()

  Prints the help usage for current set of options. This is a handy method if one wants to define a help option. In such case:

   public class MyOptions implements ArgsProcessor {
     @Arg(longName="help")
     public boolean help;
   
     @Override
     public void process(Env env) {
       if (help) env.usage();
     }
   }
   

  This method finds associated CommandLine and calls its usage method to print the help text to getOutputStream().

  Since:

  2.21