_ Git - ldk-java/blob - src/main/java/org/ldk/structs/RouteParameters.java

   1 package org.ldk.structs;
   2
   3 import org.ldk.impl.bindings;
   4 import org.ldk.enums.*;
   5 import org.ldk.util.*;
   6 import java.util.Arrays;
   7 import java.lang.ref.Reference;
   8 import javax.annotation.Nullable;
   9
  10
  11 /**
  12  * Parameters needed to find a [`Route`].
  13  *
  14  * Passed to [`find_route`] and [`build_route_from_hops`].
  15  */
  16 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  17 public class RouteParameters extends CommonBase {
  18         RouteParameters(Object _dummy, long ptr) { super(ptr); }
  19         @Override @SuppressWarnings("deprecation")
  20         protected void finalize() throws Throwable {
  21                 super.finalize();
  22                 if (ptr != 0) { bindings.RouteParameters_free(ptr); }
  23         }
  24
  25         /**
  26          * The parameters of the failed payment path.
  27          */
  28         public PaymentParameters get_payment_params() {
  29                 long ret = bindings.RouteParameters_get_payment_params(this.ptr);
  30                 Reference.reachabilityFence(this);
  31                 if (ret >= 0 && ret <= 4096) { return null; }
  32                 org.ldk.structs.PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PaymentParameters(null, ret); }
  33                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
  34                 return ret_hu_conv;
  35         }
  36
  37         /**
  38          * The parameters of the failed payment path.
  39          */
  40         public void set_payment_params(org.ldk.structs.PaymentParameters val) {
  41                 bindings.RouteParameters_set_payment_params(this.ptr, val == null ? 0 : val.ptr);
  42                 Reference.reachabilityFence(this);
  43                 Reference.reachabilityFence(val);
  44                 if (this != null) { this.ptrs_to.add(val); };
  45         }
  46
  47         /**
  48          * The amount in msats sent on the failed payment path.
  49          */
  50         public long get_final_value_msat() {
  51                 long ret = bindings.RouteParameters_get_final_value_msat(this.ptr);
  52                 Reference.reachabilityFence(this);
  53                 return ret;
  54         }
  55
  56         /**
  57          * The amount in msats sent on the failed payment path.
  58          */
  59         public void set_final_value_msat(long val) {
  60                 bindings.RouteParameters_set_final_value_msat(this.ptr, val);
  61                 Reference.reachabilityFence(this);
  62                 Reference.reachabilityFence(val);
  63         }
  64
  65         /**
  66          * Constructs a new RouteParameters given each field
  67          */
  68         public static RouteParameters of(org.ldk.structs.PaymentParameters payment_params_arg, long final_value_msat_arg) {
  69                 long ret = bindings.RouteParameters_new(payment_params_arg == null ? 0 : payment_params_arg.ptr, final_value_msat_arg);
  70                 Reference.reachabilityFence(payment_params_arg);
  71                 Reference.reachabilityFence(final_value_msat_arg);
  72                 if (ret >= 0 && ret <= 4096) { return null; }
  73                 org.ldk.structs.RouteParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.RouteParameters(null, ret); }
  74                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
  75                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(payment_params_arg); };
  76                 return ret_hu_conv;
  77         }
  78
  79         long clone_ptr() {
  80                 long ret = bindings.RouteParameters_clone_ptr(this.ptr);
  81                 Reference.reachabilityFence(this);
  82                 return ret;
  83         }
  84
  85         /**
  86          * Creates a copy of the RouteParameters
  87          */
  88         public RouteParameters clone() {
  89                 long ret = bindings.RouteParameters_clone(this.ptr);
  90                 Reference.reachabilityFence(this);
  91                 if (ret >= 0 && ret <= 4096) { return null; }
  92                 org.ldk.structs.RouteParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.RouteParameters(null, ret); }
  93                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
  94                 return ret_hu_conv;
  95         }
  96
  97         /**
  98          * Checks if two RouteParameterss contain equal inner contents.
  99          * This ignores pointers and is_owned flags and looks at the values in fields.
 100          * Two objects with NULL inner values will be considered "equal" here.
 101          */
 102         public boolean eq(org.ldk.structs.RouteParameters b) {
 103                 boolean ret = bindings.RouteParameters_eq(this.ptr, b == null ? 0 : b.ptr);
 104                 Reference.reachabilityFence(this);
 105                 Reference.reachabilityFence(b);
 106                 if (this != null) { this.ptrs_to.add(b); };
 107                 return ret;
 108         }
 109
 110         @Override public boolean equals(Object o) {
 111                 if (!(o instanceof RouteParameters)) return false;
 112                 return this.eq((RouteParameters)o);
 113         }
 114         /**
 115          * Serialize the RouteParameters object into a byte array which can be read by RouteParameters_read
 116          */
 117         public byte[] write() {
 118                 byte[] ret = bindings.RouteParameters_write(this.ptr);
 119                 Reference.reachabilityFence(this);
 120                 return ret;
 121         }
 122
 123         /**
 124          * Read a RouteParameters from a byte array, created by RouteParameters_write
 125          */
 126         public static Result_RouteParametersDecodeErrorZ read(byte[] ser) {
 127                 long ret = bindings.RouteParameters_read(ser);
 128                 Reference.reachabilityFence(ser);
 129                 if (ret >= 0 && ret <= 4096) { return null; }
 130                 Result_RouteParametersDecodeErrorZ ret_hu_conv = Result_RouteParametersDecodeErrorZ.constr_from_ptr(ret);
 131                 return ret_hu_conv;
 132         }
 133
 134 }