Mercurial > hg > orthanc-java
comparison JavaSDK/be/uclouvain/orthanc/Job.java @ 0:3ecef5782f2c
initial commit
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 18 Oct 2023 17:59:44 +0200 |
parents | |
children | 26c08ff926a3 |
comparison
equal
deleted
inserted
replaced
-1:000000000000 | 0:3ecef5782f2c |
---|---|
1 package be.uclouvain.orthanc; | |
2 | |
3 /** | |
4 * SPDX-FileCopyrightText: 2023 Sebastien Jodogne, UCLouvain, Belgium | |
5 * SPDX-License-Identifier: GPL-3.0-or-later | |
6 */ | |
7 | |
8 /** | |
9 * Java plugin for Orthanc | |
10 * Copyright (C) 2023 Sebastien Jodogne, UCLouvain, Belgium | |
11 * | |
12 * This program is free software: you can redistribute it and/or | |
13 * modify it under the terms of the GNU General Public License as | |
14 * published by the Free Software Foundation, either version 3 of the | |
15 * License, or (at your option) any later version. | |
16 * | |
17 * This program is distributed in the hope that it will be useful, but | |
18 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
20 * General Public License for more details. | |
21 * | |
22 * You should have received a copy of the GNU General Public License | |
23 * along with this program. If not, see http://www.gnu.org/licenses/. | |
24 **/ | |
25 | |
26 | |
27 /** | |
28 * Orthanc job | |
29 **/ | |
30 public class Job { | |
31 private long self; | |
32 | |
33 /** | |
34 * Construct a Java object wrapping a C object that is managed by Orthanc. | |
35 * @param self Pointer to the C object. | |
36 **/ | |
37 protected Job(long self) { | |
38 if (self == 0) { | |
39 throw new IllegalArgumentException("Null pointer"); | |
40 } else { | |
41 this.self = self; | |
42 } | |
43 } | |
44 | |
45 /** | |
46 * Return the C object that is associated with this Java wrapper. | |
47 * @return Pointer to the C object. | |
48 **/ | |
49 protected long getSelf() { | |
50 return self; | |
51 } | |
52 | |
53 @Override | |
54 protected void finalize() throws Throwable { | |
55 dispose(); | |
56 super.finalize(); | |
57 } | |
58 | |
59 /** | |
60 * Manually deallocate the C object that is associated with this Java wrapper. | |
61 * | |
62 * This method can be used to immediately deallocate the C object, | |
63 * instead of waiting for the garbage collector to dispose the Java wrapper. | |
64 **/ | |
65 public void dispose() { | |
66 if (self != 0) { | |
67 NativeSDK.OrthancPluginFreeJob(self); | |
68 self = 0; | |
69 } | |
70 } | |
71 | |
72 | |
73 /** | |
74 * Submit a new job to the jobs engine of Orthanc. | |
75 * | |
76 * This function adds the given job to the pending jobs of Orthanc. Orthanc will | |
77 * take take of freeing it by invoking the finalization callback provided to | |
78 * OrthancPluginCreateJob(). | |
79 * | |
80 * @param priority The priority of the job. | |
81 * @return The resulting string. | |
82 **/ | |
83 public String submitJob( | |
84 int priority) { | |
85 return NativeSDK.OrthancPluginSubmitJob(self, priority); | |
86 } | |
87 | |
88 } |