Class InterfaceCompanion<I,Id,View>
- java.lang.Object
-
- com.daml.ledger.javaapi.data.codegen.ContractTypeCompanion<Contract<Id,View>,Id,I,View>
-
- com.daml.ledger.javaapi.data.codegen.InterfaceCompanion<I,Id,View>
-
- Type Parameters:
I
- The generated interface marker class.View
- TheDamlRecord
subclass representing the interface view, as may be retrieved from the ACS or transaction stream.
public abstract class InterfaceCompanion<I,Id,View> extends ContractTypeCompanion<Contract<Id,View>,Id,I,View>
Metadata and utilities associated with an interface as a whole. Its subclasses serve to disambiguate various generatedtoInterface
overloads.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
InterfaceCompanion.FromJson<T>
-
Field Summary
Fields Modifier and Type Field Description ValueDecoder<View>
valueDecoder
-
Fields inherited from class com.daml.ledger.javaapi.data.codegen.ContractTypeCompanion
choices, TEMPLATE_ID
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Contract<Id,View>
fromCreatedEvent(CreatedEvent event)
Tries to parse a contract from an event expected to create aCt
contract.View
fromJson(java.lang.String json)
-
Methods inherited from class com.daml.ledger.javaapi.data.codegen.ContractTypeCompanion
toContractId
-
-
-
-
Field Detail
-
valueDecoder
public final ValueDecoder<View> valueDecoder
-
-
Method Detail
-
fromJson
public View fromJson(java.lang.String json) throws JsonLfDecoder.Error
- Throws:
JsonLfDecoder.Error
-
fromCreatedEvent
public final Contract<Id,View> fromCreatedEvent(CreatedEvent event) throws java.lang.IllegalArgumentException
Description copied from class:ContractTypeCompanion
Tries to parse a contract from an event expected to create aCt
contract. This is either theCreatedEvent.getArguments()
forContractCompanion
, or one ofCreatedEvent.getInterfaceViews()
for anInterfaceCompanion
.- Specified by:
fromCreatedEvent
in classContractTypeCompanion<Contract<Id,View>,Id,I,View>
- Parameters:
event
- the event to try to parse a contract from- Returns:
- The parsed contract, with payload and metadata, if present.
- Throws:
java.lang.IllegalArgumentException
- when theCreatedEvent
payload cannot be parsed asData
, or theCreatedEvent.getContractKey()
cannot be parsed as a contract key.
-
-