Package io.bdeploy.common.cli.data

Class DataResultBase

java.lang.Object

io.bdeploy.common.cli.data.DataResultBase

All Implemented Interfaces:

DataResult, RenderableResult

Direct Known Subclasses:

DataResultCsv, DataResultJson, DataResultText

public abstract class DataResultBase
extends Object
implements DataResult

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DataResultBase(PrintStream output)

Method Summary

Modifier and Type	Method	Description
DataResult	addField(String name, Object value)	Adds a data field to the result.
ExitCode	getExitCode()
Map<String,String>	getFields()
String	getMessage()
protected Throwable	getThrowable()
protected PrintStream	out()
DataResult	setException(Throwable t)
DataResult	setExitCode(ExitCode exitCode)
DataResult	setMessage(String message)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.bdeploy.common.cli.data.RenderableResult

render

Constructor Details

DataResultBase

protected DataResultBase(PrintStream output)

Method Details

out

protected PrintStream out()

getMessage

public String getMessage()

Specified by:

getMessage in interface DataResult

Returns:

the message for testability

getFields

public Map<String,String> getFields()

Specified by:

getFields in interface DataResult

Returns:

the fields in the result for testability

getThrowable

protected Throwable getThrowable()

setMessage

public DataResult setMessage(String message)

Specified by:

setMessage in interface DataResult

Parameters:

message - the "main" result message.

setException

public DataResult setException(Throwable t)

Specified by:

setException in interface DataResult

Parameters:

t - the exception in case one happened.

addField

public DataResult addField(String name,
 Object value)

Description copied from interface: DataResult

Adds a data field to the result. This can be any data "produced" by the tool, e.g. an ID generated by the tool, etc.

Specified by:

addField in interface DataResult

Parameters:

name - name of the field.

value - the value of the field.

setExitCode

public DataResult setExitCode(ExitCode exitCode)

Specified by:

setExitCode in interface DataResult

Parameters:

exitCode - indicates whether operation was successful or had any errors.

getExitCode

public ExitCode getExitCode()

Specified by:

getExitCode in interface RenderableResult