Package io.iworkflow.core.communication
Class SignalChannelDef
- java.lang.Object
-
- io.iworkflow.core.communication.SignalChannelDef
-
- All Implemented Interfaces:
CommunicationMethodDef
@Immutable public abstract class SignalChannelDef extends java.lang.Object implements CommunicationMethodDef
-
-
Constructor Summary
Constructors Constructor Description SignalChannelDef()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static SignalChannelDef
create(java.lang.Class type, java.lang.String name)
iWF will verify if the name has been registered for the signal channel created using this method, allowing users to create only one signal channel with the same name and type.static SignalChannelDef
createByPrefix(java.lang.Class type, java.lang.String namePrefix)
iWF now supports dynamically created signal channels with a shared name prefix and the same type.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface io.iworkflow.core.communication.CommunicationMethodDef
getName, getValueType, isPrefix
-
-
-
-
Method Detail
-
create
public static SignalChannelDef create(java.lang.Class type, java.lang.String name)
iWF will verify if the name has been registered for the signal channel created using this method, allowing users to create only one signal channel with the same name and type.- Parameters:
type
- required.name
- required. The unique name.- Returns:
- a signal channel definition
-
createByPrefix
public static SignalChannelDef createByPrefix(java.lang.Class type, java.lang.String namePrefix)
iWF now supports dynamically created signal channels with a shared name prefix and the same type. (E.g., dynamically created signal channels of type String can be named with a common prefix like: signal_channel_prefix_1: "one", signal_channel_prefix_2: "two") iWF will verify if the prefix has been registered for signal channels created using this method, allowing users to create multiple signal channels with the same name prefix and type.- Parameters:
type
- required.namePrefix
- required. The common name prefix of a set of signal channels to be created later.- Returns:
- a signal channel definition
-
-