Class ContractCompanion<Ct,Id,Data>
- java.lang.Object
-
- com.daml.ledger.javaapi.data.codegen.ContractTypeCompanion<Ct,Id,Data,Data>
-
- com.daml.ledger.javaapi.data.codegen.ContractCompanion<Ct,Id,Data>
-
- Type Parameters:
Ct- TheContractsubclass generated within the template class.Id- TheContractIdsubclass generated within the template class.Data- The generatedTemplatesubclass named after the template, whose instances contain only the payload.
- Direct Known Subclasses:
ContractCompanion.WithKey,ContractCompanion.WithoutKey
public abstract class ContractCompanion<Ct,Id,Data> extends ContractTypeCompanion<Ct,Id,Data,Data>
Metadata and utilities associated with a template as a whole, rather than one single contract made from that template.Application code should not instantiate or subclass; instead, refer to the
COMPANIONfield on generatedTemplatesubclasses. Allprotectedmembers herein are considered part of the INTERNAL API.Every instance is either a
ContractCompanion.WithKeyorContractCompanion.WithoutKey, depending on whether the template defined akeytype.ContractCompanion.WithKeydefines extra utilities for working with contract keys.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classContractCompanion.WithKey<Ct,Id,Data,Key>static classContractCompanion.WithoutKey<Ct,Id,Data>
-
Field Summary
-
Fields inherited from class com.daml.ledger.javaapi.data.codegen.ContractTypeCompanion
choices, TEMPLATE_ID
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static <Data> ValueDecoder<Data>valueDecoder(ContractCompanion<?,? extends ContractId<Data>,Data> companion)Static method to generate an implementation ofValueDecoderof typeDatawith metadata from the providedContractCompanion.-
Methods inherited from class com.daml.ledger.javaapi.data.codegen.ContractTypeCompanion
fromCreatedEvent, toContractId
-
-
-
-
Method Detail
-
valueDecoder
public static <Data> ValueDecoder<Data> valueDecoder(ContractCompanion<?,? extends ContractId<Data>,Data> companion)
Static method to generate an implementation ofValueDecoderof typeDatawith metadata from the providedContractCompanion.- Parameters:
companion- an instance ofContractCompanion.- Returns:
- The
ValueDecoderfor parsingValueto get an instance ofData.
-
-