Class OfferCreateFlags


public class OfferCreateFlags extends TransactionFlags
A set of static TransactionFlags which can be set on OfferCreate transactions.
  • Field Details

  • Method Details

    • builder

      public static OfferCreateFlags.Builder builder()
      Returns:
      A new OfferCreateFlags.Builder.
    • of

      public static OfferCreateFlags of(long value)
      Construct OfferCreateFlags with a given value.
      Parameters:
      value - The long-number encoded flags value of this OfferCreateFlags.
      Returns:
      New OfferCreateFlags.
    • empty

      public static OfferCreateFlags empty()
      Construct an empty instance of OfferCreateFlags. Transactions with empty flags will not be serialized with a Flags field.
      Returns:
      An empty OfferCreateFlags.
    • tfPassive

      public boolean tfPassive()
      If enabled, the offer does not consume offers that exactly match it, and instead becomes an Offer object in the ledger. It still consumes offers that cross it.
      Returns:
      true if tfPassive is set, otherwise false.
    • tfImmediateOrCancel

      public boolean tfImmediateOrCancel()
      Treat the offer as an Immediate or Cancel order . If enabled, the offer never becomes a ledger object: it only tries to match existing offers in the ledger. If the offer cannot match any offers immediately, it executes "successfully" without trading any currency. In this case, the transaction has the result code tesSUCCESS, but creates no Offer objects in the ledger.
      Returns:
      true if tfImmediateOrCancel is set, otherwise false.
    • tfFillOrKill

      public boolean tfFillOrKill()
      Treat the offer as a Fill or Kill order . Only try to match existing offers in the ledger, and only do so if the entire TakerPays quantity can be obtained. If the fix1578 amendment is enabled and the offer cannot be executed when placed, the transaction has the result code tecKILLED; otherwise, the transaction uses the result code tesSUCCESS even when it was killed without trading any currency.
      Returns:
      true if tfFillOrKill is set, otherwise false.
    • tfSell

      public boolean tfSell()
      Exchange the entire TakerGets amount, even if it means obtaining more than the TakerPays amount in exchange.
      Returns:
      true if tfSell is set, otherwise false.
    • tfHybrid

      public boolean tfHybrid()
      Indicates the offer is hybrid.
      Returns:
      true if tfHybrid is set, otherwise false.
    • tfInnerBatchTxn

      public boolean tfInnerBatchTxn()
      Indicates that this transaction is an inner transaction of a Batch transaction.
      Overrides:
      tfInnerBatchTxn in class TransactionFlags
      Returns:
      true if tfInnerBatchTxn is set, otherwise false.
      See Also:
      • "https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0056-batch"