Update auto-updated Java files
[ldk-java] / src / main / java / org / ldk / structs / QueryChannelRange.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  * A query_channel_range message is used to query a peer for channel
13  * UTXOs in a range of blocks. The recipient of a query makes a best
14  * effort to reply to the query using one or more reply_channel_range
15  * messages.
16  */
17 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
18 public class QueryChannelRange extends CommonBase {
19         QueryChannelRange(Object _dummy, long ptr) { super(ptr); }
20         @Override @SuppressWarnings("deprecation")
21         protected void finalize() throws Throwable {
22                 super.finalize();
23                 if (ptr != 0) { bindings.QueryChannelRange_free(ptr); }
24         }
25
26         /**
27          * The genesis hash of the blockchain being queried
28          */
29         public byte[] get_chain_hash() {
30                 byte[] ret = bindings.QueryChannelRange_get_chain_hash(this.ptr);
31                 Reference.reachabilityFence(this);
32                 return ret;
33         }
34
35         /**
36          * The genesis hash of the blockchain being queried
37          */
38         public void set_chain_hash(byte[] val) {
39                 bindings.QueryChannelRange_set_chain_hash(this.ptr, InternalUtils.check_arr_len(val, 32));
40                 Reference.reachabilityFence(this);
41                 Reference.reachabilityFence(val);
42         }
43
44         /**
45          * The height of the first block for the channel UTXOs being queried
46          */
47         public int get_first_blocknum() {
48                 int ret = bindings.QueryChannelRange_get_first_blocknum(this.ptr);
49                 Reference.reachabilityFence(this);
50                 return ret;
51         }
52
53         /**
54          * The height of the first block for the channel UTXOs being queried
55          */
56         public void set_first_blocknum(int val) {
57                 bindings.QueryChannelRange_set_first_blocknum(this.ptr, val);
58                 Reference.reachabilityFence(this);
59                 Reference.reachabilityFence(val);
60         }
61
62         /**
63          * The number of blocks to include in the query results
64          */
65         public int get_number_of_blocks() {
66                 int ret = bindings.QueryChannelRange_get_number_of_blocks(this.ptr);
67                 Reference.reachabilityFence(this);
68                 return ret;
69         }
70
71         /**
72          * The number of blocks to include in the query results
73          */
74         public void set_number_of_blocks(int val) {
75                 bindings.QueryChannelRange_set_number_of_blocks(this.ptr, val);
76                 Reference.reachabilityFence(this);
77                 Reference.reachabilityFence(val);
78         }
79
80         /**
81          * Constructs a new QueryChannelRange given each field
82          */
83         public static QueryChannelRange of(byte[] chain_hash_arg, int first_blocknum_arg, int number_of_blocks_arg) {
84                 long ret = bindings.QueryChannelRange_new(InternalUtils.check_arr_len(chain_hash_arg, 32), first_blocknum_arg, number_of_blocks_arg);
85                 Reference.reachabilityFence(chain_hash_arg);
86                 Reference.reachabilityFence(first_blocknum_arg);
87                 Reference.reachabilityFence(number_of_blocks_arg);
88                 if (ret >= 0 && ret <= 4096) { return null; }
89                 QueryChannelRange ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new QueryChannelRange(null, ret); }
90                 ret_hu_conv.ptrs_to.add(ret_hu_conv);
91                 return ret_hu_conv;
92         }
93
94         long clone_ptr() {
95                 long ret = bindings.QueryChannelRange_clone_ptr(this.ptr);
96                 Reference.reachabilityFence(this);
97                 return ret;
98         }
99
100         /**
101          * Creates a copy of the QueryChannelRange
102          */
103         public QueryChannelRange clone() {
104                 long ret = bindings.QueryChannelRange_clone(this.ptr);
105                 Reference.reachabilityFence(this);
106                 if (ret >= 0 && ret <= 4096) { return null; }
107                 QueryChannelRange ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new QueryChannelRange(null, ret); }
108                 ret_hu_conv.ptrs_to.add(this);
109                 return ret_hu_conv;
110         }
111
112         /**
113          * \n\t * Calculates the overflow safe ending block height for the query.\n\t * Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`\n\t
114          */
115         public int end_blocknum() {
116                 int ret = bindings.QueryChannelRange_end_blocknum(this.ptr);
117                 Reference.reachabilityFence(this);
118                 return ret;
119         }
120
121         /**
122          * Serialize the QueryChannelRange object into a byte array which can be read by QueryChannelRange_read
123          */
124         public byte[] write() {
125                 byte[] ret = bindings.QueryChannelRange_write(this.ptr);
126                 Reference.reachabilityFence(this);
127                 return ret;
128         }
129
130         /**
131          * Read a QueryChannelRange from a byte array, created by QueryChannelRange_write
132          */
133         public static Result_QueryChannelRangeDecodeErrorZ read(byte[] ser) {
134                 long ret = bindings.QueryChannelRange_read(ser);
135                 Reference.reachabilityFence(ser);
136                 if (ret >= 0 && ret <= 4096) { return null; }
137                 Result_QueryChannelRangeDecodeErrorZ ret_hu_conv = Result_QueryChannelRangeDecodeErrorZ.constr_from_ptr(ret);
138                 return ret_hu_conv;
139         }
140
141 }