public class TransactionState<T extends ContractState>
A wrapper for interface ContractState
containing additional platform-level state information and contract information.
This is the definitive state that is stored on the ledger and used in transaction outputs.
interface ContractState
Modifier and Type | Field and Description |
---|---|
static net.corda.core.contracts.TransactionState.Companion |
Companion
Deprecated.
|
Constructor and Description |
---|
TransactionState(T data,
java.lang.String contract,
Party notary,
java.lang.Integer encumbrance,
AttachmentConstraint constraint)
A wrapper for
interface ContractState containing additional platform-level state information and contract information.
This is the definitive state that is stored on the ledger and used in transaction outputs. |
Modifier and Type | Method and Description |
---|---|
T |
component1()
The custom contract state
|
java.lang.String |
component2()
The contract class name that will verify this state that will be created via reflection.
The attachment containing this class will be automatically added to the transaction at transaction creation
time.
|
Party |
component3()
Identity of the notary that ensures the state is not used as an input to a transaction more than once
|
java.lang.Integer |
component4()
All contract states may be encumbered by up to one other state.
|
AttachmentConstraint |
component5()
A validator for the contract attachments on the transaction.
|
TransactionState<T> |
copy(T data,
java.lang.String contract,
Party notary,
java.lang.Integer encumbrance,
AttachmentConstraint constraint)
A wrapper for
interface ContractState containing additional platform-level state information and contract information.
This is the definitive state that is stored on the ledger and used in transaction outputs. |
boolean |
equals(java.lang.Object p) |
AttachmentConstraint |
getConstraint()
A validator for the contract attachments on the transaction.
|
java.lang.String |
getContract()
The contract class name that will verify this state that will be created via reflection.
The attachment containing this class will be automatically added to the transaction at transaction creation
time.
|
T |
getData()
The custom contract state
|
java.lang.Integer |
getEncumbrance()
All contract states may be encumbered by up to one other state.
|
Party |
getNotary()
Identity of the notary that ensures the state is not used as an input to a transaction more than once
|
int |
hashCode() |
java.lang.String |
toString() |
public static net.corda.core.contracts.TransactionState.Companion Companion
public TransactionState(T data, java.lang.String contract, Party notary, java.lang.Integer encumbrance, AttachmentConstraint constraint)
A wrapper for interface ContractState
containing additional platform-level state information and contract information.
This is the definitive state that is stored on the ledger and used in transaction outputs.
data
- The custom contract statecontract
- The contract class name that will verify this state that will be created via reflection. The attachment containing this class will be automatically added to the transaction at transaction creation time.
Currently these are loaded from the classpath of the node which includes the cordapp directory - at some point these will also be loaded and run from the attachment store directly, allowing contracts to be sent across, and run, from the network from within a sandbox environment.
notary
- Identity of the notary that ensures the state is not used as an input to a transaction more than onceencumbrance
- All contract states may be encumbered by up to one other state.
The encumbrance state, if present, forces additional controls over the encumbered state, since the platform checks that the encumbrance state is present as an input in the same transaction that consumes the encumbered state, and the contract code and rules of the encumbrance state will also be verified during the execution of the transaction. For example, a cash contract state could be encumbered with a time-lock contract state; the cash state is then only processable in a transaction that verifies that the time specified in the encumbrance time-lock has passed.
The encumbered state refers to another by index, and the referred encumbrance state
is an output state in a particular position on the same transaction that created the encumbered state. An alternative
implementation would be encumbering by reference to a class StateRef
, which would allow the specification of encumbrance
by a state created in a prior transaction.
Note that an encumbered state that is being consumed must have its encumbrance consumed in the same transaction, otherwise the transaction is not valid.
constraint
- A validator for the contract attachments on the transaction.interface ContractState
public T getData()
The custom contract state
public java.lang.String getContract()
The contract class name that will verify this state that will be created via reflection. The attachment containing this class will be automatically added to the transaction at transaction creation time.
Currently these are loaded from the classpath of the node which includes the cordapp directory - at some point these will also be loaded and run from the attachment store directly, allowing contracts to be sent across, and run, from the network from within a sandbox environment.
public Party getNotary()
Identity of the notary that ensures the state is not used as an input to a transaction more than once
public java.lang.Integer getEncumbrance()
All contract states may be encumbered by up to one other state.
The encumbrance state, if present, forces additional controls over the encumbered state, since the platform checks that the encumbrance state is present as an input in the same transaction that consumes the encumbered state, and the contract code and rules of the encumbrance state will also be verified during the execution of the transaction. For example, a cash contract state could be encumbered with a time-lock contract state; the cash state is then only processable in a transaction that verifies that the time specified in the encumbrance time-lock has passed.
The encumbered state refers to another by index, and the referred encumbrance state
is an output state in a particular position on the same transaction that created the encumbered state. An alternative
implementation would be encumbering by reference to a class StateRef
, which would allow the specification of encumbrance
by a state created in a prior transaction.
Note that an encumbered state that is being consumed must have its encumbrance consumed in the same transaction, otherwise the transaction is not valid.
class StateRef
public AttachmentConstraint getConstraint()
A validator for the contract attachments on the transaction.
public T component1()
The custom contract state
public java.lang.String component2()
The contract class name that will verify this state that will be created via reflection. The attachment containing this class will be automatically added to the transaction at transaction creation time.
Currently these are loaded from the classpath of the node which includes the cordapp directory - at some point these will also be loaded and run from the attachment store directly, allowing contracts to be sent across, and run, from the network from within a sandbox environment.
public Party component3()
Identity of the notary that ensures the state is not used as an input to a transaction more than once
public java.lang.Integer component4()
All contract states may be encumbered by up to one other state.
The encumbrance state, if present, forces additional controls over the encumbered state, since the platform checks that the encumbrance state is present as an input in the same transaction that consumes the encumbered state, and the contract code and rules of the encumbrance state will also be verified during the execution of the transaction. For example, a cash contract state could be encumbered with a time-lock contract state; the cash state is then only processable in a transaction that verifies that the time specified in the encumbrance time-lock has passed.
The encumbered state refers to another by index, and the referred encumbrance state
is an output state in a particular position on the same transaction that created the encumbered state. An alternative
implementation would be encumbering by reference to a class StateRef
, which would allow the specification of encumbrance
by a state created in a prior transaction.
Note that an encumbered state that is being consumed must have its encumbrance consumed in the same transaction, otherwise the transaction is not valid.
class StateRef
public AttachmentConstraint component5()
A validator for the contract attachments on the transaction.
public TransactionState<T> copy(T data, java.lang.String contract, Party notary, java.lang.Integer encumbrance, AttachmentConstraint constraint)
A wrapper for interface ContractState
containing additional platform-level state information and contract information.
This is the definitive state that is stored on the ledger and used in transaction outputs.
interface ContractState
public java.lang.String toString()
public int hashCode()
public boolean equals(java.lang.Object p)