X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FBolt11InvoiceFeatures.java;fp=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FBolt11InvoiceFeatures.java;h=46ee4e94f900015e1002bd96aca2c2ea0ad85bdc;hb=8fa2bcb208a51fa352d04981f1387d8bceced107;hp=0000000000000000000000000000000000000000;hpb=7da1092518e5ea1518255a4473c178f52549fd81;p=ldk-java diff --git a/src/main/java/org/ldk/structs/Bolt11InvoiceFeatures.java b/src/main/java/org/ldk/structs/Bolt11InvoiceFeatures.java new file mode 100644 index 00000000..46ee4e94 --- /dev/null +++ b/src/main/java/org/ldk/structs/Bolt11InvoiceFeatures.java @@ -0,0 +1,282 @@ +package org.ldk.structs; + +import org.ldk.impl.bindings; +import org.ldk.enums.*; +import org.ldk.util.*; +import java.util.Arrays; +import java.lang.ref.Reference; +import javax.annotation.Nullable; + + +/** + * Features used within an invoice. + */ +@SuppressWarnings("unchecked") // We correctly assign various generic arrays +public class Bolt11InvoiceFeatures extends CommonBase { + Bolt11InvoiceFeatures(Object _dummy, long ptr) { super(ptr); } + @Override @SuppressWarnings("deprecation") + protected void finalize() throws Throwable { + super.finalize(); + if (ptr != 0) { bindings.Bolt11InvoiceFeatures_free(ptr); } + } + + /** + * Checks if two Bolt11InvoiceFeaturess contain equal inner contents. + * This ignores pointers and is_owned flags and looks at the values in fields. + * Two objects with NULL inner values will be considered "equal" here. + */ + public boolean eq(org.ldk.structs.Bolt11InvoiceFeatures b) { + boolean ret = bindings.Bolt11InvoiceFeatures_eq(this.ptr, b == null ? 0 : b.ptr); + Reference.reachabilityFence(this); + Reference.reachabilityFence(b); + if (this != null) { this.ptrs_to.add(b); }; + return ret; + } + + @Override public boolean equals(Object o) { + if (!(o instanceof Bolt11InvoiceFeatures)) return false; + return this.eq((Bolt11InvoiceFeatures)o); + } + long clone_ptr() { + long ret = bindings.Bolt11InvoiceFeatures_clone_ptr(this.ptr); + Reference.reachabilityFence(this); + return ret; + } + + /** + * Creates a copy of the Bolt11InvoiceFeatures + */ + public Bolt11InvoiceFeatures clone() { + long ret = bindings.Bolt11InvoiceFeatures_clone(this.ptr); + Reference.reachabilityFence(this); + if (ret >= 0 && ret <= 4096) { return null; } + org.ldk.structs.Bolt11InvoiceFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Bolt11InvoiceFeatures(null, ret); } + if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); }; + return ret_hu_conv; + } + + /** + * Create a blank Features with no features set + */ + public static Bolt11InvoiceFeatures empty() { + long ret = bindings.Bolt11InvoiceFeatures_empty(); + if (ret >= 0 && ret <= 4096) { return null; } + org.ldk.structs.Bolt11InvoiceFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Bolt11InvoiceFeatures(null, ret); } + if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); }; + return ret_hu_conv; + } + + /** + * Returns true if this `Features` object contains required features unknown by `other`. + */ + public boolean requires_unknown_bits_from(org.ldk.structs.Bolt11InvoiceFeatures other) { + boolean ret = bindings.Bolt11InvoiceFeatures_requires_unknown_bits_from(this.ptr, other == null ? 0 : other.ptr); + Reference.reachabilityFence(this); + Reference.reachabilityFence(other); + if (this != null) { this.ptrs_to.add(other); }; + return ret; + } + + /** + * Returns true if this `Features` object contains unknown feature flags which are set as + * \"required\". + */ + public boolean requires_unknown_bits() { + boolean ret = bindings.Bolt11InvoiceFeatures_requires_unknown_bits(this.ptr); + Reference.reachabilityFence(this); + return ret; + } + + /** + * Sets a required custom feature bit. Errors if `bit` is outside the custom range as defined + * by [bLIP 2] or if it is a known `T` feature. + * + * Note: Required bits are even. If an odd bit is given, then the corresponding even bit will + * be set instead (i.e., `bit - 1`). + * + * [bLIP 2]: https://github.com/lightning/blips/blob/master/blip-0002.md#feature-bits + */ + public Result_NoneNoneZ set_required_custom_bit(long bit) { + long ret = bindings.Bolt11InvoiceFeatures_set_required_custom_bit(this.ptr, bit); + Reference.reachabilityFence(this); + Reference.reachabilityFence(bit); + if (ret >= 0 && ret <= 4096) { return null; } + Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret); + return ret_hu_conv; + } + + /** + * Sets an optional custom feature bit. Errors if `bit` is outside the custom range as defined + * by [bLIP 2] or if it is a known `T` feature. + * + * Note: Optional bits are odd. If an even bit is given, then the corresponding odd bit will be + * set instead (i.e., `bit + 1`). + * + * [bLIP 2]: https://github.com/lightning/blips/blob/master/blip-0002.md#feature-bits + */ + public Result_NoneNoneZ set_optional_custom_bit(long bit) { + long ret = bindings.Bolt11InvoiceFeatures_set_optional_custom_bit(this.ptr, bit); + Reference.reachabilityFence(this); + Reference.reachabilityFence(bit); + if (ret >= 0 && ret <= 4096) { return null; } + Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret); + return ret_hu_conv; + } + + /** + * Serialize the Bolt11InvoiceFeatures object into a byte array which can be read by Bolt11InvoiceFeatures_read + */ + public byte[] write() { + byte[] ret = bindings.Bolt11InvoiceFeatures_write(this.ptr); + Reference.reachabilityFence(this); + return ret; + } + + /** + * Read a Bolt11InvoiceFeatures from a byte array, created by Bolt11InvoiceFeatures_write + */ + public static Result_Bolt11InvoiceFeaturesDecodeErrorZ read(byte[] ser) { + long ret = bindings.Bolt11InvoiceFeatures_read(ser); + Reference.reachabilityFence(ser); + if (ret >= 0 && ret <= 4096) { return null; } + Result_Bolt11InvoiceFeaturesDecodeErrorZ ret_hu_conv = Result_Bolt11InvoiceFeaturesDecodeErrorZ.constr_from_ptr(ret); + return ret_hu_conv; + } + + /** + * Set this feature as optional. + */ + public void set_variable_length_onion_optional() { + bindings.Bolt11InvoiceFeatures_set_variable_length_onion_optional(this.ptr); + Reference.reachabilityFence(this); + } + + /** + * Set this feature as required. + */ + public void set_variable_length_onion_required() { + bindings.Bolt11InvoiceFeatures_set_variable_length_onion_required(this.ptr); + Reference.reachabilityFence(this); + } + + /** + * Checks if this feature is supported. + */ + public boolean supports_variable_length_onion() { + boolean ret = bindings.Bolt11InvoiceFeatures_supports_variable_length_onion(this.ptr); + Reference.reachabilityFence(this); + return ret; + } + + /** + * Checks if this feature is required. + */ + public boolean requires_variable_length_onion() { + boolean ret = bindings.Bolt11InvoiceFeatures_requires_variable_length_onion(this.ptr); + Reference.reachabilityFence(this); + return ret; + } + + /** + * Set this feature as optional. + */ + public void set_payment_secret_optional() { + bindings.Bolt11InvoiceFeatures_set_payment_secret_optional(this.ptr); + Reference.reachabilityFence(this); + } + + /** + * Set this feature as required. + */ + public void set_payment_secret_required() { + bindings.Bolt11InvoiceFeatures_set_payment_secret_required(this.ptr); + Reference.reachabilityFence(this); + } + + /** + * Checks if this feature is supported. + */ + public boolean supports_payment_secret() { + boolean ret = bindings.Bolt11InvoiceFeatures_supports_payment_secret(this.ptr); + Reference.reachabilityFence(this); + return ret; + } + + /** + * Checks if this feature is required. + */ + public boolean requires_payment_secret() { + boolean ret = bindings.Bolt11InvoiceFeatures_requires_payment_secret(this.ptr); + Reference.reachabilityFence(this); + return ret; + } + + /** + * Set this feature as optional. + */ + public void set_basic_mpp_optional() { + bindings.Bolt11InvoiceFeatures_set_basic_mpp_optional(this.ptr); + Reference.reachabilityFence(this); + } + + /** + * Set this feature as required. + */ + public void set_basic_mpp_required() { + bindings.Bolt11InvoiceFeatures_set_basic_mpp_required(this.ptr); + Reference.reachabilityFence(this); + } + + /** + * Checks if this feature is supported. + */ + public boolean supports_basic_mpp() { + boolean ret = bindings.Bolt11InvoiceFeatures_supports_basic_mpp(this.ptr); + Reference.reachabilityFence(this); + return ret; + } + + /** + * Checks if this feature is required. + */ + public boolean requires_basic_mpp() { + boolean ret = bindings.Bolt11InvoiceFeatures_requires_basic_mpp(this.ptr); + Reference.reachabilityFence(this); + return ret; + } + + /** + * Set this feature as optional. + */ + public void set_payment_metadata_optional() { + bindings.Bolt11InvoiceFeatures_set_payment_metadata_optional(this.ptr); + Reference.reachabilityFence(this); + } + + /** + * Set this feature as required. + */ + public void set_payment_metadata_required() { + bindings.Bolt11InvoiceFeatures_set_payment_metadata_required(this.ptr); + Reference.reachabilityFence(this); + } + + /** + * Checks if this feature is supported. + */ + public boolean supports_payment_metadata() { + boolean ret = bindings.Bolt11InvoiceFeatures_supports_payment_metadata(this.ptr); + Reference.reachabilityFence(this); + return ret; + } + + /** + * Checks if this feature is required. + */ + public boolean requires_payment_metadata() { + boolean ret = bindings.Bolt11InvoiceFeatures_requires_payment_metadata(this.ptr); + Reference.reachabilityFence(this); + return ret; + } + +}