Class TrustSetFlags


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

    • UNSET

      protected static final TrustSetFlags UNSET
      Constant for an unset flag.
    • SET_F_AUTH

      protected static final TrustSetFlags SET_F_AUTH
      Constant TrustSetFlags for the tfSetfAuth flag.
    • SET_NO_RIPPLE

      protected static final TrustSetFlags SET_NO_RIPPLE
      Constant TrustSetFlags for the tfSetNoRipple flag.
    • CLEAR_NO_RIPPLE

      protected static final TrustSetFlags CLEAR_NO_RIPPLE
      Constant TrustSetFlags for the tfClearNoRipple flag.
    • SET_FREEZE

      protected static final TrustSetFlags SET_FREEZE
      Constant TrustSetFlags for the tfSetFreeze flag.
    • CLEAR_FREEZE

      protected static final TrustSetFlags CLEAR_FREEZE
      Constant TrustSetFlags for the tfClearFreeze flag.
    • SET_DEEP_FREEZE

      protected static final TrustSetFlags SET_DEEP_FREEZE
      Constant TrustSetFlags for the tfSetDeepFreeze flag.
    • CLEAR_DEEP_FREEZE

      protected static final TrustSetFlags CLEAR_DEEP_FREEZE
      Constant TrustSetFlags for the tfClearDeepFreeze flag.
    • INNER_BATCH_TXN

      public static final TrustSetFlags INNER_BATCH_TXN
      Constant TrustSetFlags for the tfInnerBatchTxn flag. This flag is used to indicate that a transaction is an inner transaction of a Batch.
      See Also:
      • "https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0056-batch"
  • Method Details

    • builder

      public static TrustSetFlags.Builder builder()
      Create a new TrustSetFlags.Builder.
      Returns:
      A new TrustSetFlags.Builder.
    • of

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

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

      public boolean tfFullyCanonicalSig()
      Require a fully canonical signature.
      Overrides:
      tfFullyCanonicalSig in class TransactionFlags
      Returns:
      true if tfFullyCanonicalSig is set, otherwise false.
      See Also:
      • "https://xrpl.org/transaction-common-fields.html#flags-field"
    • tfSetfAuth

      public boolean tfSetfAuth()
      Authorize the other party to hold currency issued by this account. (No effect unless using AccountSet.AccountSetFlag.REQUIRE_AUTH). Cannot be unset.
      Returns:
      true if tfSetfAuth is set, otherwise false.
    • tfSetNoRipple

      public boolean tfSetNoRipple()
      Enable the No Ripple flag, which blocks rippling between two trust lines of the same currency if this flag is enabled on both.
      Returns:
      true if tfSetNoRipple is set, otherwise false.
    • tfClearNoRipple

      public boolean tfClearNoRipple()
      Disable the No Ripple flag, allowing rippling on this trust line.
      Returns:
      true if tfClearNoRipple is set, otherwise false.
    • tfSetFreeze

      public boolean tfSetFreeze()
      Freeze the trust line.
      Returns:
      true if tfSetFreeze is set, otherwise false.
    • tfClearFreeze

      public boolean tfClearFreeze()
      Unfreeze the trust line.
      Returns:
      true if tfClearFreeze is set, otherwise false.
    • tfSetDeepFreeze

      public boolean tfSetDeepFreeze()
      Deep freeze the trust line.
      Returns:
      true if tfSetDeepFreeze is set, otherwise false.
    • tfClearDeepFreeze

      public boolean tfClearDeepFreeze()
      Clear deep freeze on the trust line.
      Returns:
      true if tfClearDeepFreeze 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"