Clarifying the need for a single Party c'tor for InitiatedBy flows

This commit is contained in:
Shams Asari 2017-07-06 12:27:38 +01:00
parent 177f591e57
commit 54aa4802f9

View File

@ -4,8 +4,10 @@ import kotlin.annotation.AnnotationTarget.CLASS
import kotlin.reflect.KClass import kotlin.reflect.KClass
/** /**
* This annotation is required by any [FlowLogic] that is designed to be initiated by a counterparty flow. The flow that * This annotation is required by any [FlowLogic] that is designed to be initiated by a counterparty flow. The class must
* does the initiating is specified by the [value] property and itself must be annotated with [InitiatingFlow]. * have at least a constructor which takes in a single [net.corda.core.identity.Party] parameter which represents the
* initiating counterparty. The [FlowLogic] that does the initiating is specified by the [value] property and itself must be annotated
* with [InitiatingFlow].
* *
* The node on startup scans for [FlowLogic]s which are annotated with this and automatically registers the initiating * The node on startup scans for [FlowLogic]s which are annotated with this and automatically registers the initiating
* to initiated flow mapping. * to initiated flow mapping.