BilateralNettableState
Keywords: net.corda.finance.contracts.BilateralNettableState interface
Date: 2023-09-18

net.corda.finance.contracts

## Interface BilateralNettableState<N extends BilateralNettableState<N>>

- All Known Subinterfaces:
    NettableState<N,T>
  All Known Implementing Classes:
    Obligation.State

      public BilateralNettableState<N extends BilateralNettableState<N>>

  Interface for state objects that support being netted with other state objects.

- - ### Constructor Detail

    - #### BilateralNettableState

          public BilateralNettableState()

  - ### Method Detail

    - #### getBilateralNetState

          @NotNull
          java.lang.Object getBilateralNetState()

      Returns an object used to determine if two states can be subject to close-out netting. If two states return equal objects, they can be close out netted together.

    - #### net

          @NotNull
          N net(@NotNull
                         N other)

      Perform bilateral netting of this state with another state. The two states must be compatible (as in bilateralNetState objects are equal).