Package io.openems.edge.controller.api.common

Class WritePojo

java.lang.Object

io.openems.edge.controller.api.common.WriteObject

io.openems.edge.controller.api.common.WritePojo

public class WritePojo
extends WriteObject

A Wrapper for writing a POJO (plain old java object) to a WriteChannel.

Field Summary

Fields

Modifier and Type	Field	Description
final Object	value

Constructor Summary

Constructors

Constructor	Description
WritePojo(Object value)

Method Summary

Modifier and Type	Method	Description
boolean	isNull()	Is there a defined value?.
void	setNextWriteValue(WriteChannel<?> writeChannel)	Set the next write value of the Channel.
String	valueToString()	Gets the value as a String for logging purposes.

Methods inherited from class io.openems.edge.controller.api.common.WriteObject

notifyError, notifySuccess, notifyTimeout, onError, onFirstError, onFirstSuccess, onSuccess, onTimeout

Methods inherited from class java.lang.Object

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

Field Details

value

public final Object value

Constructor Details

WritePojo

public WritePojo(Object value)

Method Details

setNextWriteValue

public void setNextWriteValue(WriteChannel<?> writeChannel)
                       throws OpenemsError.OpenemsNamedException

Description copied from class: WriteObject

Set the next write value of the Channel.

Specified by:

setNextWriteValue in class WriteObject

Parameters:

writeChannel - the WriteChannel

Throws:

OpenemsError.OpenemsNamedException - on error

valueToString

public String valueToString()

Description copied from class: WriteObject

Gets the value as a String for logging purposes.

Specified by:

valueToString in class WriteObject

Returns:

the value as String

isNull

public boolean isNull()

Description copied from class: WriteObject

Is there a defined value?.

Specified by:

isNull in class WriteObject

Returns:

true if no value is there; false if a value is available.