_ Git - ldk-java/blob - src/main/java/org/ldk/structs/Bolt11InvoiceFeatures.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  * Features used within an invoice.
  13  */
  14 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  15 public class Bolt11InvoiceFeatures extends CommonBase {
  16         Bolt11InvoiceFeatures(Object _dummy, long ptr) { super(ptr); }
  17         @Override @SuppressWarnings("deprecation")
  18         protected void finalize() throws Throwable {
  19                 super.finalize();
  20                 if (ptr != 0) { bindings.Bolt11InvoiceFeatures_free(ptr); }
  21         }
  22
  23         /**
  24          * Checks if two Bolt11InvoiceFeaturess contain equal inner contents.
  25          * This ignores pointers and is_owned flags and looks at the values in fields.
  26          * Two objects with NULL inner values will be considered "equal" here.
  27          */
  28         public boolean eq(org.ldk.structs.Bolt11InvoiceFeatures b) {
  29                 boolean ret = bindings.Bolt11InvoiceFeatures_eq(this.ptr, b == null ? 0 : b.ptr);
  30                 Reference.reachabilityFence(this);
  31                 Reference.reachabilityFence(b);
  32                 if (this != null) { this.ptrs_to.add(b); };
  33                 return ret;
  34         }
  35
  36         @Override public boolean equals(Object o) {
  37                 if (!(o instanceof Bolt11InvoiceFeatures)) return false;
  38                 return this.eq((Bolt11InvoiceFeatures)o);
  39         }
  40         long clone_ptr() {
  41                 long ret = bindings.Bolt11InvoiceFeatures_clone_ptr(this.ptr);
  42                 Reference.reachabilityFence(this);
  43                 return ret;
  44         }
  45
  46         /**
  47          * Creates a copy of the Bolt11InvoiceFeatures
  48          */
  49         public Bolt11InvoiceFeatures clone() {
  50                 long ret = bindings.Bolt11InvoiceFeatures_clone(this.ptr);
  51                 Reference.reachabilityFence(this);
  52                 if (ret >= 0 && ret <= 4096) { return null; }
  53                 org.ldk.structs.Bolt11InvoiceFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Bolt11InvoiceFeatures(null, ret); }
  54                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
  55                 return ret_hu_conv;
  56         }
  57
  58         /**
  59          * Create a blank Features with no features set
  60          */
  61         public static Bolt11InvoiceFeatures empty() {
  62                 long ret = bindings.Bolt11InvoiceFeatures_empty();
  63                 if (ret >= 0 && ret <= 4096) { return null; }
  64                 org.ldk.structs.Bolt11InvoiceFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Bolt11InvoiceFeatures(null, ret); }
  65                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
  66                 return ret_hu_conv;
  67         }
  68
  69         /**
  70          * Returns true if this `Features` object contains required features unknown by `other`.
  71          */
  72         public boolean requires_unknown_bits_from(org.ldk.structs.Bolt11InvoiceFeatures other) {
  73                 boolean ret = bindings.Bolt11InvoiceFeatures_requires_unknown_bits_from(this.ptr, other == null ? 0 : other.ptr);
  74                 Reference.reachabilityFence(this);
  75                 Reference.reachabilityFence(other);
  76                 if (this != null) { this.ptrs_to.add(other); };
  77                 return ret;
  78         }
  79
  80         /**
  81          * Returns true if this `Features` object contains unknown feature flags which are set as
  82          * \"required\".
  83          */
  84         public boolean requires_unknown_bits() {
  85                 boolean ret = bindings.Bolt11InvoiceFeatures_requires_unknown_bits(this.ptr);
  86                 Reference.reachabilityFence(this);
  87                 return ret;
  88         }
  89
  90         /**
  91          * Sets a required custom feature bit. Errors if `bit` is outside the custom range as defined
  92          * by [bLIP 2] or if it is a known `T` feature.
  93          *
  94          * Note: Required bits are even. If an odd bit is given, then the corresponding even bit will
  95          * be set instead (i.e., `bit - 1`).
  96          *
  97          * [bLIP 2]: https://github.com/lightning/blips/blob/master/blip-0002.md#feature-bits
  98          */
  99         public Result_NoneNoneZ set_required_custom_bit(long bit) {
 100                 long ret = bindings.Bolt11InvoiceFeatures_set_required_custom_bit(this.ptr, bit);
 101                 Reference.reachabilityFence(this);
 102                 Reference.reachabilityFence(bit);
 103                 if (ret >= 0 && ret <= 4096) { return null; }
 104                 Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret);
 105                 return ret_hu_conv;
 106         }
 107
 108         /**
 109          * Sets an optional custom feature bit. Errors if `bit` is outside the custom range as defined
 110          * by [bLIP 2] or if it is a known `T` feature.
 111          *
 112          * Note: Optional bits are odd. If an even bit is given, then the corresponding odd bit will be
 113          * set instead (i.e., `bit + 1`).
 114          *
 115          * [bLIP 2]: https://github.com/lightning/blips/blob/master/blip-0002.md#feature-bits
 116          */
 117         public Result_NoneNoneZ set_optional_custom_bit(long bit) {
 118                 long ret = bindings.Bolt11InvoiceFeatures_set_optional_custom_bit(this.ptr, bit);
 119                 Reference.reachabilityFence(this);
 120                 Reference.reachabilityFence(bit);
 121                 if (ret >= 0 && ret <= 4096) { return null; }
 122                 Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret);
 123                 return ret_hu_conv;
 124         }
 125
 126         /**
 127          * Serialize the Bolt11InvoiceFeatures object into a byte array which can be read by Bolt11InvoiceFeatures_read
 128          */
 129         public byte[] write() {
 130                 byte[] ret = bindings.Bolt11InvoiceFeatures_write(this.ptr);
 131                 Reference.reachabilityFence(this);
 132                 return ret;
 133         }
 134
 135         /**
 136          * Read a Bolt11InvoiceFeatures from a byte array, created by Bolt11InvoiceFeatures_write
 137          */
 138         public static Result_Bolt11InvoiceFeaturesDecodeErrorZ read(byte[] ser) {
 139                 long ret = bindings.Bolt11InvoiceFeatures_read(ser);
 140                 Reference.reachabilityFence(ser);
 141                 if (ret >= 0 && ret <= 4096) { return null; }
 142                 Result_Bolt11InvoiceFeaturesDecodeErrorZ ret_hu_conv = Result_Bolt11InvoiceFeaturesDecodeErrorZ.constr_from_ptr(ret);
 143                 return ret_hu_conv;
 144         }
 145
 146         /**
 147          * Set this feature as optional.
 148          */
 149         public void set_variable_length_onion_optional() {
 150                 bindings.Bolt11InvoiceFeatures_set_variable_length_onion_optional(this.ptr);
 151                 Reference.reachabilityFence(this);
 152         }
 153
 154         /**
 155          * Set this feature as required.
 156          */
 157         public void set_variable_length_onion_required() {
 158                 bindings.Bolt11InvoiceFeatures_set_variable_length_onion_required(this.ptr);
 159                 Reference.reachabilityFence(this);
 160         }
 161
 162         /**
 163          * Checks if this feature is supported.
 164          */
 165         public boolean supports_variable_length_onion() {
 166                 boolean ret = bindings.Bolt11InvoiceFeatures_supports_variable_length_onion(this.ptr);
 167                 Reference.reachabilityFence(this);
 168                 return ret;
 169         }
 170
 171         /**
 172          * Checks if this feature is required.
 173          */
 174         public boolean requires_variable_length_onion() {
 175                 boolean ret = bindings.Bolt11InvoiceFeatures_requires_variable_length_onion(this.ptr);
 176                 Reference.reachabilityFence(this);
 177                 return ret;
 178         }
 179
 180         /**
 181          * Set this feature as optional.
 182          */
 183         public void set_payment_secret_optional() {
 184                 bindings.Bolt11InvoiceFeatures_set_payment_secret_optional(this.ptr);
 185                 Reference.reachabilityFence(this);
 186         }
 187
 188         /**
 189          * Set this feature as required.
 190          */
 191         public void set_payment_secret_required() {
 192                 bindings.Bolt11InvoiceFeatures_set_payment_secret_required(this.ptr);
 193                 Reference.reachabilityFence(this);
 194         }
 195
 196         /**
 197          * Checks if this feature is supported.
 198          */
 199         public boolean supports_payment_secret() {
 200                 boolean ret = bindings.Bolt11InvoiceFeatures_supports_payment_secret(this.ptr);
 201                 Reference.reachabilityFence(this);
 202                 return ret;
 203         }
 204
 205         /**
 206          * Checks if this feature is required.
 207          */
 208         public boolean requires_payment_secret() {
 209                 boolean ret = bindings.Bolt11InvoiceFeatures_requires_payment_secret(this.ptr);
 210                 Reference.reachabilityFence(this);
 211                 return ret;
 212         }
 213
 214         /**
 215          * Set this feature as optional.
 216          */
 217         public void set_basic_mpp_optional() {
 218                 bindings.Bolt11InvoiceFeatures_set_basic_mpp_optional(this.ptr);
 219                 Reference.reachabilityFence(this);
 220         }
 221
 222         /**
 223          * Set this feature as required.
 224          */
 225         public void set_basic_mpp_required() {
 226                 bindings.Bolt11InvoiceFeatures_set_basic_mpp_required(this.ptr);
 227                 Reference.reachabilityFence(this);
 228         }
 229
 230         /**
 231          * Checks if this feature is supported.
 232          */
 233         public boolean supports_basic_mpp() {
 234                 boolean ret = bindings.Bolt11InvoiceFeatures_supports_basic_mpp(this.ptr);
 235                 Reference.reachabilityFence(this);
 236                 return ret;
 237         }
 238
 239         /**
 240          * Checks if this feature is required.
 241          */
 242         public boolean requires_basic_mpp() {
 243                 boolean ret = bindings.Bolt11InvoiceFeatures_requires_basic_mpp(this.ptr);
 244                 Reference.reachabilityFence(this);
 245                 return ret;
 246         }
 247
 248         /**
 249          * Set this feature as optional.
 250          */
 251         public void set_payment_metadata_optional() {
 252                 bindings.Bolt11InvoiceFeatures_set_payment_metadata_optional(this.ptr);
 253                 Reference.reachabilityFence(this);
 254         }
 255
 256         /**
 257          * Set this feature as required.
 258          */
 259         public void set_payment_metadata_required() {
 260                 bindings.Bolt11InvoiceFeatures_set_payment_metadata_required(this.ptr);
 261                 Reference.reachabilityFence(this);
 262         }
 263
 264         /**
 265          * Checks if this feature is supported.
 266          */
 267         public boolean supports_payment_metadata() {
 268                 boolean ret = bindings.Bolt11InvoiceFeatures_supports_payment_metadata(this.ptr);
 269                 Reference.reachabilityFence(this);
 270                 return ret;
 271         }
 272
 273         /**
 274          * Checks if this feature is required.
 275          */
 276         public boolean requires_payment_metadata() {
 277                 boolean ret = bindings.Bolt11InvoiceFeatures_requires_payment_metadata(this.ptr);
 278                 Reference.reachabilityFence(this);
 279                 return ret;
 280         }
 281
 282 }