Class SIS.Help

Object
Help
All Implemented Interfaces:
Cloneable
Enclosing class:
SIS
public static final class SIS.Help extends Object
Builder for the "help" sub-command. This builder provides convenience methods for setting options before to execute the command by a call to run(Object...).
Since:
1.5
See Also:

  • Method Details

    • locale

      public SIS.Help locale(String value)
      Sets the locale to use for the command output.
      Parameters:
      value - the language and country code.
      Returns:
      a new builder or this, for method call chaining.

    • encoding

      public SIS.Help encoding(String value)
      Sets encoding to use for the command outputs. This option rarely needs to be specified.
      Parameters:
      value - the character set name.
      Returns:
      a new builder or this, for method call chaining.

    • debug

      public SIS.Help debug()
      Prints full stack trace in case of failure.
      Returns:
      a new builder or this, for method call chaining.

    • help

      public SIS.Help help()
      Lists the options available for the sub-command.
      Returns:
      a new builder or this, for method call chaining.

    • run

      public void run(Object... args) throws Exception
      Executes the command with the given arguments. The arguments are usually String instances, but may also be instances of File, Path, URL, URI or other types accepted by Storage­Connector if the corresponding argument specifies an input or output.
      Parameters:
      args - the arguments to pass to the sub-command.
      name - name of the sub-command to execute.
      Throws:
      Exception - if an error occurred while executing the command.

    • toString

      public String toString()
      Returns the command with all options that have been set..
      Overrides:
      to­String in class Object
      Returns:
      the command with all options that have been set