[Java] Update auto-generated Java bindings to LDK 0.0.121
[ldk-java] / src / main / java / org / ldk / structs / Shutdown.java
index 1d1c91d5cc3fd7afe2edaeb6e1804534e557d708..56f8712a40b781ed7db11932c64dc81d073d0314 100644 (file)
@@ -4,7 +4,15 @@ 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;
 
+
+/**
+ * A [`shutdown`] message to be sent to or received from a peer.
+ * 
+ * [`shutdown`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#closing-initiation-shutdown
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class Shutdown extends CommonBase {
        Shutdown(Object _dummy, long ptr) { super(ptr); }
@@ -14,46 +22,123 @@ public class Shutdown extends CommonBase {
                if (ptr != 0) { bindings.Shutdown_free(ptr); }
        }
 
-       public static Shutdown constructor_clone(Shutdown orig) {
-               long ret = bindings.Shutdown_clone(orig == null ? 0 : orig.ptr & ~1);
-               Shutdown ret_hu_conv = new Shutdown(null, ret);
-               ret_hu_conv.ptrs_to.add(orig);
-               return ret_hu_conv;
-       }
-
+       /**
+        * The channel ID
+        */
        public byte[] get_channel_id() {
                byte[] ret = bindings.Shutdown_get_channel_id(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * The channel ID
+        */
        public void set_channel_id(byte[] val) {
-               bindings.Shutdown_set_channel_id(this.ptr, val);
+               bindings.Shutdown_set_channel_id(this.ptr, InternalUtils.check_arr_len(val, 32));
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * The destination of this peer's funds on closing.
+        * 
+        * Must be in one of these forms: P2PKH, P2SH, P2WPKH, P2WSH, P2TR.
+        */
        public byte[] get_scriptpubkey() {
                byte[] ret = bindings.Shutdown_get_scriptpubkey(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * The destination of this peer's funds on closing.
+        * 
+        * Must be in one of these forms: P2PKH, P2SH, P2WPKH, P2WSH, P2TR.
+        */
        public void set_scriptpubkey(byte[] val) {
                bindings.Shutdown_set_scriptpubkey(this.ptr, val);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
+       }
+
+       /**
+        * Constructs a new Shutdown given each field
+        */
+       public static Shutdown of(byte[] channel_id_arg, byte[] scriptpubkey_arg) {
+               long ret = bindings.Shutdown_new(InternalUtils.check_arr_len(channel_id_arg, 32), scriptpubkey_arg);
+               Reference.reachabilityFence(channel_id_arg);
+               Reference.reachabilityFence(scriptpubkey_arg);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.Shutdown ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Shutdown(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+               return ret_hu_conv;
+       }
+
+       long clone_ptr() {
+               long ret = bindings.Shutdown_clone_ptr(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
        }
 
-       public static Shutdown constructor_new(byte[] channel_id_arg, byte[] scriptpubkey_arg) {
-               long ret = bindings.Shutdown_new(channel_id_arg, scriptpubkey_arg);
-               Shutdown ret_hu_conv = new Shutdown(null, ret);
+       /**
+        * Creates a copy of the Shutdown
+        */
+       public Shutdown clone() {
+               long ret = bindings.Shutdown_clone(this.ptr);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.Shutdown ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Shutdown(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
                return ret_hu_conv;
        }
 
-       public byte[] write(Shutdown obj) {
-               byte[] ret = bindings.Shutdown_write(obj == null ? 0 : obj.ptr & ~1);
-               this.ptrs_to.add(obj);
+       /**
+        * Generates a non-cryptographic 64-bit hash of the Shutdown.
+        */
+       public long hash() {
+               long ret = bindings.Shutdown_hash(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
+       @Override public int hashCode() {
+               return (int)this.hash();
+       }
+       /**
+        * Checks if two Shutdowns 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.Shutdown b) {
+               boolean ret = bindings.Shutdown_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 Shutdown)) return false;
+               return this.eq((Shutdown)o);
+       }
+       /**
+        * Serialize the Shutdown object into a byte array which can be read by Shutdown_read
+        */
+       public byte[] write() {
+               byte[] ret = bindings.Shutdown_write(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
-       public static Shutdown constructor_read(byte[] ser) {
+       /**
+        * Read a Shutdown from a byte array, created by Shutdown_write
+        */
+       public static Result_ShutdownDecodeErrorZ read(byte[] ser) {
                long ret = bindings.Shutdown_read(ser);
-               Shutdown ret_hu_conv = new Shutdown(null, ret);
+               Reference.reachabilityFence(ser);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               Result_ShutdownDecodeErrorZ ret_hu_conv = Result_ShutdownDecodeErrorZ.constr_from_ptr(ret);
                return ret_hu_conv;
        }