Method Detail

• getUsage

  java.lang.String getUsage​()

  Usage message for this filter. This should contain any arguments which apply to this item; the name itself should not be included. May contain newline characters to break up a long line.

  Returns:

  usage string

• getDescription

  java.lang.String getDescription​()

  Description for this filter. This is currently inserted into the user document, so should be in XML format.

  Returns:

  textual description of this filter

• createStep

  ProcessingStep createStep​(java.util.Iterator argIt)
                     throws ArgException

  Creates a new ProcessingStep based on a sequence of command-line arguments. The argIt argument is an iterator over the command-line arguments positioned just before any arguments intended for this filter. If legal, any that can be comprehended by this filter should be read (iterated over) and removed, and a ProcessingStep should accordingly be returned. In the case of a successful return, it is essential that no arguments other than the ones intended for this filter are read from the iterator.

  If the argument list is badly-formed as far as this filter is concerned, an ArgException should be thrown. If its usageFrament is blank, it will be filled in later using this mode's usage text.

  Parameters:

  argIt - iterator over command-line arguments positioned at the first one

  Throws:

  ArgException