ContractCompanion

java.lang.Object
- com.daml.ledger.javaapi.data.codegen.ContractTypeCompanion<Data,Data>
- - com.daml.ledger.javaapi.data.codegen.ContractCompanion<Ct,Id,Data>

Type Parameters:

Ct - The Contract subclass generated within the template class.

Id - The ContractId subclass generated within the template class.

Data - The generated Template subclass 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<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 COMPANION field on generated Template subclasses. All protected members herein are considered part of the INTERNAL API.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ContractCompanion.WithKey<Ct,Id,Data,Key>

static class ContractCompanion.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 Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract Ct`	`fromCreatedEvent(CreatedEvent event)`	Tries to parse a contract from an event expected to create a `Ct` contract.
`Id`	`toContractId(ContractId<Data> parameterizedContractId)`
`static <Data> ValueDecoder<Data>`	`valueDecoder(ContractCompanion<?,? extends ContractId<Data>,Data> companion)`	Static method to generate an implementation of `ValueDecoder` of type `Data` with metadata from the provided `ContractCompanion`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - valueDecoder
```
public static <Data> ValueDecoder<Data> valueDecoder(ContractCompanion<?,? extends ContractId<Data>,Data> companion)
```
    Static method to generate an implementation of ValueDecoder of type Data with metadata from the provided ContractCompanion.
    
    Parameters:
    
    companion - an instance of ContractCompanion.
    
    Returns:
    
    The ValueDecoder for parsing Value to get an instance of Data.
  - fromCreatedEvent
```
public abstract Ct fromCreatedEvent(CreatedEvent event)
```
    Tries to parse a contract from an event expected to create a Ct contract.
    
    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.arguments cannot be parsed as Data, or the CreatedEvent.contractKey cannot be parsed as Key.
  - toContractId
```
public Id toContractId(ContractId<Data> parameterizedContractId)
```