Package liquibase.command

Class CommandResultsBuilder

java.lang.Object

liquibase.command.CommandResultsBuilder

public class CommandResultsBuilder
extends Object

Because CommandResults is immutable, this class is used to build up the results during CommandStep.run(CommandResultsBuilder).

Method Summary

Modifier and Type	Method	Description
CommandResultsBuilder	addResult(String key, Object value)	Adds a key/value pair to the command results.
<T> CommandResultsBuilder	addResult(CommandResultDefinition<T> definition, T value)	Sets the value for a known CommandResultDefinition to the command results.
CommandFailedException	commandFailed(String message, int exitCode)
CommandFailedException	commandFailed(String message, int exitCode, boolean expected)
CommandScope	getCommandScope()	Return the CommandScope the results are being built for.
OutputStream	getOutputStream()	Returns the OutputStream for output for the command.
Object	getResult(String key)	Allows any step of the pipeline to access any of the results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCommandScope

public CommandScope getCommandScope()

Return the CommandScope the results are being built for.

getOutputStream

public OutputStream getOutputStream()

Returns the OutputStream for output for the command.

See Also:

CommandScope.setOutput(OutputStream)

addResult

public CommandResultsBuilder addResult(String key,
                                       Object value)

Adds a key/value pair to the command results.

See Also:

addResult(CommandResultDefinition, Object)

getResult

public Object getResult(String key)

Allows any step of the pipeline to access any of the results.

addResult

public <T> CommandResultsBuilder addResult(CommandResultDefinition<T> definition,
                                           T value)

Sets the value for a known CommandResultDefinition to the command results.

commandFailed

public CommandFailedException commandFailed(String message,
                                            int exitCode)

commandFailed

public CommandFailedException commandFailed(String message,
                                            int exitCode,
                                            boolean expected)