State pointers are always resolved, so the kdocs should reflect this. (#4716)

This commit is contained in:
Roger Willis 2019-02-06 09:52:11 +00:00 committed by GitHub
parent 7866dde91b
commit 0360a33e5c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -503,11 +503,9 @@ open class TransactionBuilder(
private fun checkReferencesUseSameNotary() = referencesWithTransactionState.map { it.notary }.toSet().size == 1
/**
* If any inputs or outputs added to the [TransactionBuilder] contain [StatePointer]s, then this method can be
* optionally called to resolve those [StatePointer]s to [StateAndRef]s. The [StateAndRef]s are then added as
* reference states to the transaction. The effect is that the referenced data is carried along with the
* transaction. This may or may not be appropriate in all circumstances, which is why calling this method is
* optional.
* If any inputs or outputs added to the [TransactionBuilder] contain [StatePointer]s, then this method is used
* to resolve those [StatePointer]s to [StateAndRef]s. The [StateAndRef]s are then added as reference states to
* the transaction. The effect is that the referenced data is carried along with the transaction.
*
* If this method is called outside the context of a flow, a [ServiceHub] instance must be passed to this method
* for it to be able to resolve [StatePointer]s. Usually for a unit test, this will be an instance of mock services.