Package com.daml.ledger.javaapi.data.codegen

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 - The DamlRecord 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 generated toInterface 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, TEMPLATE_ID_WITH_PACKAGE_ID

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InterfaceCompanion(java.lang.String templateClassName, Identifier templateId, java.util.function.Function<java.lang.String,Id> newContractId, ValueDecoder<View> valueDecoder, InterfaceCompanion.FromJson<View> fromJson, java.util.List<Choice<I,?,?>> choices)

Method Summary

Modifier and Type	Method	Description
Contract<Id,View>	fromCreatedEvent(CreatedEvent event)	Tries to parse a contract from an event expected to create a Ct contract.
View	fromJson(java.lang.String json)

Methods inherited from class com.daml.ledger.javaapi.data.codegen.ContractTypeCompanion

toContractId

Methods inherited from class java.lang.Object

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

Field Detail

valueDecoder

public final ValueDecoder<View> valueDecoder

Constructor Detail

InterfaceCompanion

protected InterfaceCompanion(java.lang.String templateClassName,
                             Identifier templateId,
                             java.util.function.Function<java.lang.String,Id> newContractId,
                             ValueDecoder<View> valueDecoder,
                             InterfaceCompanion.FromJson<View> fromJson,
                             java.util.List<Choice<I,?,?>> choices)

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 a Ct contract. This is either the CreatedEvent.getArguments() for ContractCompanion, or one of CreatedEvent.getInterfaceViews() for an InterfaceCompanion.

Specified by:

fromCreatedEvent in class ContractTypeCompanion<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 the CreatedEvent payload cannot be parsed as Data, or the CreatedEvent.getContractKey() cannot be parsed as a contract key.