c4f11b6c8983fd035f0a4b9fa497d9de3630db4b
[ldk-java] / src / main / java / org / ldk / structs / PrivateRoute.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 javax.annotation.Nullable;
8
9
10 /**
11  * Private routing information
12  * 
13  * # Invariants
14  * The encoded route has to be <1024 5bit characters long (<=639 bytes or <=12 hops)
15  */
16 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
17 public class PrivateRoute extends CommonBase {
18         PrivateRoute(Object _dummy, long ptr) { super(ptr); }
19         @Override @SuppressWarnings("deprecation")
20         protected void finalize() throws Throwable {
21                 super.finalize();
22                 if (ptr != 0) { bindings.PrivateRoute_free(ptr); }
23         }
24
25         long clone_ptr() {
26                 long ret = bindings.PrivateRoute_clone_ptr(this.ptr);
27                 return ret;
28         }
29
30         /**
31          * Creates a copy of the PrivateRoute
32          */
33         public PrivateRoute clone() {
34                 long ret = bindings.PrivateRoute_clone(this.ptr);
35                 if (ret >= 0 && ret <= 4096) { return null; }
36                 PrivateRoute ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new PrivateRoute(null, ret); }
37                 ret_hu_conv.ptrs_to.add(this);
38                 return ret_hu_conv;
39         }
40
41         /**
42          * Checks if two PrivateRoutes contain equal inner contents.
43          */
44         public long hash() {
45                 long ret = bindings.PrivateRoute_hash(this.ptr);
46                 return ret;
47         }
48
49         /**
50          * Checks if two PrivateRoutes contain equal inner contents.
51          * This ignores pointers and is_owned flags and looks at the values in fields.
52          * Two objects with NULL inner values will be considered "equal" here.
53          */
54         public boolean eq(PrivateRoute b) {
55                 boolean ret = bindings.PrivateRoute_eq(this.ptr, b == null ? 0 : b.ptr & ~1);
56                 this.ptrs_to.add(b);
57                 return ret;
58         }
59
60         /**
61          * Creates a new (partial) route from a list of hops
62          */
63         public static Result_PrivateRouteCreationErrorZ of(RouteHint hops) {
64                 long ret = bindings.PrivateRoute_new(hops == null ? 0 : hops.ptr & ~1);
65                 if (ret >= 0 && ret <= 4096) { return null; }
66                 Result_PrivateRouteCreationErrorZ ret_hu_conv = Result_PrivateRouteCreationErrorZ.constr_from_ptr(ret);
67                 return ret_hu_conv;
68         }
69
70         /**
71          * Returns the underlying list of hops
72          */
73         public RouteHint into_inner() {
74                 long ret = bindings.PrivateRoute_into_inner(this.ptr);
75                 if (ret >= 0 && ret <= 4096) { return null; }
76                 RouteHint ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new RouteHint(null, ret); }
77                 ret_hu_conv.ptrs_to.add(this);
78                 ;
79                 return ret_hu_conv;
80         }
81
82 }