1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
7 import java.lang.ref.Reference;
8 import javax.annotation.Nullable;
12 * Features used within an invoice.
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 {
20 if (ptr != 0) { bindings.Bolt11InvoiceFeatures_free(ptr); }
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.
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); };
36 @Override public boolean equals(Object o) {
37 if (!(o instanceof Bolt11InvoiceFeatures)) return false;
38 return this.eq((Bolt11InvoiceFeatures)o);
41 long ret = bindings.Bolt11InvoiceFeatures_clone_ptr(this.ptr);
42 Reference.reachabilityFence(this);
47 * Creates a copy of the Bolt11InvoiceFeatures
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); };
59 * Create a blank Features with no features set
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); };
70 * Returns true if this `Features` object contains required features unknown by `other`.
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); };
81 * Returns true if this `Features` object contains unknown feature flags which are set as
84 public boolean requires_unknown_bits() {
85 boolean ret = bindings.Bolt11InvoiceFeatures_requires_unknown_bits(this.ptr);
86 Reference.reachabilityFence(this);
91 * Sets a required feature bit. Errors if `bit` is outside the feature range as defined
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`).
97 * [BOLT 9]: https://github.com/lightning/bolts/blob/master/09-features.md
99 public Result_NoneNoneZ set_required_feature_bit(long bit) {
100 long ret = bindings.Bolt11InvoiceFeatures_set_required_feature_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);
109 * Sets an optional feature bit. Errors if `bit` is outside the feature range as defined
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`).
115 * [BOLT 9]: https://github.com/lightning/bolts/blob/master/09-features.md
117 public Result_NoneNoneZ set_optional_feature_bit(long bit) {
118 long ret = bindings.Bolt11InvoiceFeatures_set_optional_feature_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);
127 * Sets a required custom feature bit. Errors if `bit` is outside the custom range as defined
128 * by [bLIP 2] or if it is a known `T` feature.
130 * Note: Required bits are even. If an odd bit is given, then the corresponding even bit will
131 * be set instead (i.e., `bit - 1`).
133 * [bLIP 2]: https://github.com/lightning/blips/blob/master/blip-0002.md#feature-bits
135 public Result_NoneNoneZ set_required_custom_bit(long bit) {
136 long ret = bindings.Bolt11InvoiceFeatures_set_required_custom_bit(this.ptr, bit);
137 Reference.reachabilityFence(this);
138 Reference.reachabilityFence(bit);
139 if (ret >= 0 && ret <= 4096) { return null; }
140 Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret);
145 * Sets an optional custom feature bit. Errors if `bit` is outside the custom range as defined
146 * by [bLIP 2] or if it is a known `T` feature.
148 * Note: Optional bits are odd. If an even bit is given, then the corresponding odd bit will be
149 * set instead (i.e., `bit + 1`).
151 * [bLIP 2]: https://github.com/lightning/blips/blob/master/blip-0002.md#feature-bits
153 public Result_NoneNoneZ set_optional_custom_bit(long bit) {
154 long ret = bindings.Bolt11InvoiceFeatures_set_optional_custom_bit(this.ptr, bit);
155 Reference.reachabilityFence(this);
156 Reference.reachabilityFence(bit);
157 if (ret >= 0 && ret <= 4096) { return null; }
158 Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret);
163 * Serialize the Bolt11InvoiceFeatures object into a byte array which can be read by Bolt11InvoiceFeatures_read
165 public byte[] write() {
166 byte[] ret = bindings.Bolt11InvoiceFeatures_write(this.ptr);
167 Reference.reachabilityFence(this);
172 * Read a Bolt11InvoiceFeatures from a byte array, created by Bolt11InvoiceFeatures_write
174 public static Result_Bolt11InvoiceFeaturesDecodeErrorZ read(byte[] ser) {
175 long ret = bindings.Bolt11InvoiceFeatures_read(ser);
176 Reference.reachabilityFence(ser);
177 if (ret >= 0 && ret <= 4096) { return null; }
178 Result_Bolt11InvoiceFeaturesDecodeErrorZ ret_hu_conv = Result_Bolt11InvoiceFeaturesDecodeErrorZ.constr_from_ptr(ret);
183 * Set this feature as optional.
185 public void set_variable_length_onion_optional() {
186 bindings.Bolt11InvoiceFeatures_set_variable_length_onion_optional(this.ptr);
187 Reference.reachabilityFence(this);
191 * Set this feature as required.
193 public void set_variable_length_onion_required() {
194 bindings.Bolt11InvoiceFeatures_set_variable_length_onion_required(this.ptr);
195 Reference.reachabilityFence(this);
199 * Checks if this feature is supported.
201 public boolean supports_variable_length_onion() {
202 boolean ret = bindings.Bolt11InvoiceFeatures_supports_variable_length_onion(this.ptr);
203 Reference.reachabilityFence(this);
208 * Checks if this feature is required.
210 public boolean requires_variable_length_onion() {
211 boolean ret = bindings.Bolt11InvoiceFeatures_requires_variable_length_onion(this.ptr);
212 Reference.reachabilityFence(this);
217 * Set this feature as optional.
219 public void set_payment_secret_optional() {
220 bindings.Bolt11InvoiceFeatures_set_payment_secret_optional(this.ptr);
221 Reference.reachabilityFence(this);
225 * Set this feature as required.
227 public void set_payment_secret_required() {
228 bindings.Bolt11InvoiceFeatures_set_payment_secret_required(this.ptr);
229 Reference.reachabilityFence(this);
233 * Checks if this feature is supported.
235 public boolean supports_payment_secret() {
236 boolean ret = bindings.Bolt11InvoiceFeatures_supports_payment_secret(this.ptr);
237 Reference.reachabilityFence(this);
242 * Checks if this feature is required.
244 public boolean requires_payment_secret() {
245 boolean ret = bindings.Bolt11InvoiceFeatures_requires_payment_secret(this.ptr);
246 Reference.reachabilityFence(this);
251 * Set this feature as optional.
253 public void set_basic_mpp_optional() {
254 bindings.Bolt11InvoiceFeatures_set_basic_mpp_optional(this.ptr);
255 Reference.reachabilityFence(this);
259 * Set this feature as required.
261 public void set_basic_mpp_required() {
262 bindings.Bolt11InvoiceFeatures_set_basic_mpp_required(this.ptr);
263 Reference.reachabilityFence(this);
267 * Checks if this feature is supported.
269 public boolean supports_basic_mpp() {
270 boolean ret = bindings.Bolt11InvoiceFeatures_supports_basic_mpp(this.ptr);
271 Reference.reachabilityFence(this);
276 * Checks if this feature is required.
278 public boolean requires_basic_mpp() {
279 boolean ret = bindings.Bolt11InvoiceFeatures_requires_basic_mpp(this.ptr);
280 Reference.reachabilityFence(this);
285 * Set this feature as optional.
287 public void set_payment_metadata_optional() {
288 bindings.Bolt11InvoiceFeatures_set_payment_metadata_optional(this.ptr);
289 Reference.reachabilityFence(this);
293 * Set this feature as required.
295 public void set_payment_metadata_required() {
296 bindings.Bolt11InvoiceFeatures_set_payment_metadata_required(this.ptr);
297 Reference.reachabilityFence(this);
301 * Checks if this feature is supported.
303 public boolean supports_payment_metadata() {
304 boolean ret = bindings.Bolt11InvoiceFeatures_supports_payment_metadata(this.ptr);
305 Reference.reachabilityFence(this);
310 * Checks if this feature is required.
312 public boolean requires_payment_metadata() {
313 boolean ret = bindings.Bolt11InvoiceFeatures_requires_payment_metadata(this.ptr);
314 Reference.reachabilityFence(this);