io.openems.edge.controller.api.common

Class WriteObject

java.lang.Object

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

Direct Known Subclasses:

WritePojo

public abstract class WriteObject
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
WriteObject()

Method Summary

Modifier and Type	Method and Description
abstract boolean	isNull() Is there a defined value?.
void	notifyError(OpenemsException e) Notify error while setting the value.
void	notifySuccess() Notify success for setting the value.
void	notifyTimeout() Notify a timeout for setting the value.
WriteObject	onError(java.util.function.Consumer<OpenemsException> callback) Callback on error while setting the value.
WriteObject	onFirstError(java.util.function.Consumer<OpenemsException> callback) Callback on first error while setting the value.
WriteObject	onFirstSuccess(java.lang.Runnable callback) Callback on first successful setting of the value.
WriteObject	onSuccess(java.lang.Runnable callback) Callback on successful setting of the value.
WriteObject	onTimeout(java.lang.Runnable callback) Callback on timeout while setting the value.
abstract void	setNextWriteValue(WriteChannel<?> writeChannel) Set the next write value of the Channel.
abstract java.lang.String	valueToString() Gets the value as a String for logging purposes.

Methods inherited from class java.lang.Object

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

Constructor Detail

WriteObject

public WriteObject()

Method Detail

onSuccess

public WriteObject onSuccess(java.lang.Runnable callback)

Callback on successful setting of the value.

Parameters:

callback - a callback Runnable

Returns:

myself

onFirstSuccess

public WriteObject onFirstSuccess(java.lang.Runnable callback)

Callback on first successful setting of the value.

Parameters:

callback - a callback Runnable

Returns:

myself

onError

public WriteObject onError(java.util.function.Consumer<OpenemsException> callback)

Callback on error while setting the value.

Parameters:

callback - a callback Runnable

Returns:

myself

onFirstError

public WriteObject onFirstError(java.util.function.Consumer<OpenemsException> callback)

Callback on first error while setting the value.

Parameters:

callback - a callback Runnable

Returns:

myself

onTimeout

public WriteObject onTimeout(java.lang.Runnable callback)

Callback on timeout while setting the value.

Parameters:

callback - a callback Runnable

Returns:

myself

notifySuccess

public void notifySuccess()

Notify success for setting the value.

notifyError

public void notifyError(OpenemsException e)

Notify error while setting the value.

Parameters:

e - the OpenemsException

notifyTimeout

public void notifyTimeout()

Notify a timeout for setting the value.

setNextWriteValue

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

Set the next write value of the Channel.

Parameters:

writeChannel - the WriteChannel

Throws:

OpenemsError.OpenemsNamedException - on error

valueToString

public abstract java.lang.String valueToString()

Gets the value as a String for logging purposes.

Returns:

the value as String

isNull

public abstract boolean isNull()

Is there a defined value?.

Returns:

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