Package io.openems.edge.common.channel.internal

Class AbstractDoc<T>

java.lang.Object

io.openems.edge.common.channel.internal.AbstractDoc<T>

All Implemented Interfaces:

Doc

Direct Known Subclasses:

EnumDoc, OpenemsTypeDoc, StateChannelDoc

public abstract class AbstractDoc<T>
extends java.lang.Object
implements Doc

Provides static meta information for a Channel using Builder pattern.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDoc(OpenemsType type)

Method Summary

Modifier and Type	Method	Description
AbstractDoc<T>	accessMode(AccessMode accessMode)	Sets the AccessMode for the Channel.
abstract <C extends Channel<?>> C	createChannelInstance(OpenemsComponent component, ChannelId channelId)	Creates an instance of Channel for the given Channel-ID using its Channel-AbstractDoc.
AbstractDoc<T>	debug()	Activates the more verbose debug mode.
AccessMode	getAccessMode()	Gets the 'Access-Mode' information.
T	getInitialValue()	Gets the initial value.
protected java.util.List<java.util.function.Consumer<Channel<T>>>	getOnInitCallbacks()	Gets the callbacks for initialization of the actual Channel.
PersistencePriority	getPersistencePriority()	Gets the Persistence Priority.
java.lang.String	getText()	Gets the descriptive text.
OpenemsType	getType()	Gets the OpenemsType.
Unit	getUnit()	Gets the Unit.
AbstractDoc<T>	initialValue(T initialValue)	Initial-Value.
boolean	isDebug()	Is the more verbose debug mode activated?.
AbstractDoc<T>	onInit(java.util.function.Consumer<Channel<T>> callback)	Provides a callback on initialization of the actual Channel.
AbstractDoc<T>	persistencePriority(PersistencePriority persistencePriority)	Sets the PersistencePriority.
protected abstract AbstractDoc<T>	self()	Gets an instance of the correct subclass of myself.
AbstractDoc<T>	text(java.lang.String text)	Sets the descriptive text.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.openems.edge.common.channel.Doc

getChannelCategory

Constructor Detail

AbstractDoc

protected AbstractDoc(OpenemsType type)

Method Detail

self

protected abstract AbstractDoc<T> self()

Gets an instance of the correct subclass of myself.

Returns:

myself

getType

public OpenemsType getType()

Description copied from interface: Doc

Gets the OpenemsType.

Specified by:

getType in interface Doc

Returns:

the OpenemsType

accessMode

public AbstractDoc<T> accessMode(AccessMode accessMode)

Sets the AccessMode for the Channel.

This is validated on construction of the Channel by AbstractReadChannel

Parameters:

accessMode - the AccessMode

Returns:

myself

getAccessMode

public AccessMode getAccessMode()

Description copied from interface: Doc

Gets the 'Access-Mode' information.

Specified by:

getAccessMode in interface Doc

Returns:

the AccessMode

persistencePriority

public AbstractDoc<T> persistencePriority(PersistencePriority persistencePriority)

Sets the PersistencePriority. Defaults to PersistencePriority.VERY_LOW.

This parameter may be used by persistence services to decide, if the Channel should be persisted to the hard disk.

Parameters:

persistencePriority - the PersistencePriority

Returns:

myself

getPersistencePriority

public PersistencePriority getPersistencePriority()

Description copied from interface: Doc

Gets the Persistence Priority. Defaults to VERY_LOW.

This parameter may be used by persistence services to decide, if the Channel should be persisted to the hard disk.

Specified by:

getPersistencePriority in interface Doc

Returns:

the PersistencePriority

initialValue

public AbstractDoc<T> initialValue(T initialValue)

Initial-Value. Default: none

Parameters:

initialValue - the initial value

Returns:

myself

getInitialValue

public T getInitialValue()

Gets the initial value.

Returns:

the initial value

text

public AbstractDoc<T> text(java.lang.String text)

Description copied from interface: Doc

Sets the descriptive text. Defaults to an empty string.

Specified by:

text in interface Doc

Parameters:

text - the text

Returns:

myself

getText

public java.lang.String getText()

Description copied from interface: Doc

Gets the descriptive text. Defaults to empty String.

Specified by:

getText in interface Doc

Returns:

the text

getUnit

public Unit getUnit()

Description copied from interface: Doc

Gets the Unit. Defaults to NONE.

Specified by:

getUnit in interface Doc

Returns:

the unit

debug

public AbstractDoc<T> debug()

Activates the more verbose debug mode.

Returns:

myself

isDebug

public boolean isDebug()

Description copied from interface: Doc

Is the more verbose debug mode activated?.

Specified by:

isDebug in interface Doc

Returns:

true for debug mode

onInit

public AbstractDoc<T> onInit(java.util.function.Consumer<Channel<T>> callback)

Provides a callback on initialization of the actual Channel.

Parameters:

callback - the method to call on initialization

Returns:

myself

getOnInitCallbacks

protected java.util.List<java.util.function.Consumer<Channel<T>>> getOnInitCallbacks()

Gets the callbacks for initialization of the actual Channel.

Returns:

a list of callbacks

createChannelInstance

public abstract <C extends Channel<?>> C createChannelInstance(OpenemsComponent component,
                                                               ChannelId channelId)

Creates an instance of Channel for the given Channel-ID using its Channel-AbstractDoc.

Specified by:

createChannelInstance in interface Doc

Type Parameters:

C - the Channel type

Parameters:

component - the OpenemsComponent

channelId - the ChannelId

Returns:

the Channel