Package com.atlassian.bitbucket.scm

Interface CommandOutputHandler<T>

Type Parameters:
T - the object type the output handler will produce when the command is run
All Superinterfaces:
CommandHandlerSupport, CommandOutputHandlerSupport
public interface CommandOutputHandler<T> extends CommandOutputHandlerSupport
Describes a handler which processes the standard output stream from a Command and, optionally, produces some object T from it.

For commands which produce no interesting output, or for output handlers which process output in a way that does not result in an object graph (for example, handlers that directly pipe data through some sort of callback), T should be specialised as Void and getOutput() should return null.

See Also:

  • Method Details

    • getOutput

      @Nullable T getOutput()
      Retrieves the processed output, if any.

      Output handler implementations which are expected or required to produce output are encouraged to defer throwing any exception indicating no output was produced until this method is called, rather than throwing the exception during processing.

      Returns:
      the processed output, which may be null if the command produced no interesting output