Mercurial > hg > orthanc-java
annotate JavaSDK/be/uclouvain/orthanc/Job.java @ 8:26c08ff926a3
added warning about auto-generated files
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Thu, 19 Oct 2023 11:21:20 +0200 |
| parents | 3ecef5782f2c |
| children | 15dc698243ac |
| rev | line source |
|---|---|
| 0 | 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 | |
|
8
26c08ff926a3
added warning about auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
27 // WARNING: Auto-generated file. Do not modify it by hand. |
|
26c08ff926a3
added warning about auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
28 |
| 0 | 29 /** |
| 30 * Orthanc job | |
| 31 **/ | |
| 32 public class Job { | |
| 33 private long self; | |
| 34 | |
| 35 /** | |
| 36 * Construct a Java object wrapping a C object that is managed by Orthanc. | |
| 37 * @param self Pointer to the C object. | |
| 38 **/ | |
| 39 protected Job(long self) { | |
| 40 if (self == 0) { | |
| 41 throw new IllegalArgumentException("Null pointer"); | |
| 42 } else { | |
| 43 this.self = self; | |
| 44 } | |
| 45 } | |
| 46 | |
| 47 /** | |
| 48 * Return the C object that is associated with this Java wrapper. | |
| 49 * @return Pointer to the C object. | |
| 50 **/ | |
| 51 protected long getSelf() { | |
| 52 return self; | |
| 53 } | |
| 54 | |
| 55 @Override | |
| 56 protected void finalize() throws Throwable { | |
| 57 dispose(); | |
| 58 super.finalize(); | |
| 59 } | |
| 60 | |
| 61 /** | |
| 62 * Manually deallocate the C object that is associated with this Java wrapper. | |
| 63 * | |
| 64 * This method can be used to immediately deallocate the C object, | |
| 65 * instead of waiting for the garbage collector to dispose the Java wrapper. | |
| 66 **/ | |
| 67 public void dispose() { | |
| 68 if (self != 0) { | |
| 69 NativeSDK.OrthancPluginFreeJob(self); | |
| 70 self = 0; | |
| 71 } | |
| 72 } | |
| 73 | |
| 74 | |
| 75 /** | |
| 76 * Submit a new job to the jobs engine of Orthanc. | |
| 77 * | |
| 78 * This function adds the given job to the pending jobs of Orthanc. Orthanc will | |
| 79 * take take of freeing it by invoking the finalization callback provided to | |
| 80 * OrthancPluginCreateJob(). | |
| 81 * | |
| 82 * @param priority The priority of the job. | |
| 83 * @return The resulting string. | |
| 84 **/ | |
| 85 public String submitJob( | |
| 86 int priority) { | |
| 87 return NativeSDK.OrthancPluginSubmitJob(self, priority); | |
| 88 } | |
| 89 | |
| 90 } |