Class CmdLineTool

java.lang.Object
opennlp.tools.cmdline.CmdLineTool
Direct Known Subclasses:
BasicCmdLineTool, TypedCmdLineTool

public abstract class CmdLineTool extends Object
Base class for all command line tools.
  • Constructor Details

    • CmdLineTool

      protected CmdLineTool()
  • Method Details

    • getName

      public String getName()
      Returns:
      Retrieves the name of the command line tool. The name (used as command) must not contain white spaces.
    • hasParams

      public boolean hasParams()
      Returns:
      Retrieves whether the tool has any command line params
    • getBasicHelp

      protected String getBasicHelp(Class<?> argProxyInterface)
    • getBasicHelp

      protected String getBasicHelp(Class<?>... argProxyInterfaces)
    • getHelp

      public abstract String getHelp()
      Returns:
      Retrieves a description on how to use the tool
    • validateAndParseParams

      protected <T> T validateAndParseParams(String[] args, Class<T> argProxyInterface)
    • getShortDescription

      public String getShortDescription()
      Returns:
      Retrieves a short description of what the tool does