Mercurial > hg > orthanc-java
annotate JavaSDK/be/uclouvain/orthanc/JobStopReason.java @ 17:443d5b7d733e
sync
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Fri, 05 Jan 2024 16:29:13 +0100 |
| parents | 26c08ff926a3 |
| 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 * Explains why the job should stop and release the resources it has allocated. | |
| 31 * This is especially important to disambiguate between the "paused" condition and | |
| 32 * the "final" conditions (success, failure, or canceled). | |
| 33 **/ | |
| 34 public enum JobStopReason { | |
| 35 /** | |
| 36 * The job has succeeded | |
| 37 **/ | |
| 38 SUCCESS(1), | |
| 39 /** | |
| 40 * The job was paused, and will be resumed later | |
| 41 **/ | |
| 42 PAUSED(2), | |
| 43 /** | |
| 44 * The job has failed, and might be resubmitted later | |
| 45 **/ | |
| 46 FAILURE(3), | |
| 47 /** | |
| 48 * The job was canceled, and might be resubmitted later | |
| 49 **/ | |
| 50 CANCELED(4); | |
| 51 | |
| 52 private int value; | |
| 53 | |
| 54 private JobStopReason(int value) { | |
| 55 this.value = value; | |
| 56 } | |
| 57 | |
| 58 /** | |
| 59 * Return the enumeration value that corresponds to an integer value of interest. | |
| 60 * @param value The integer value. | |
| 61 * @return The enumeration value. | |
| 62 **/ | |
| 63 protected static JobStopReason getInstance(int value) { | |
| 64 if (value == 1) { | |
| 65 return SUCCESS; | |
| 66 } | |
| 67 if (value == 2) { | |
| 68 return PAUSED; | |
| 69 } | |
| 70 if (value == 3) { | |
| 71 return FAILURE; | |
| 72 } | |
| 73 if (value == 4) { | |
| 74 return CANCELED; | |
| 75 } | |
| 76 | |
| 77 throw new IllegalArgumentException("Value out of range for enumeration JobStopReason: " + value); | |
| 78 } | |
| 79 | |
| 80 /** | |
| 81 * Get the integer value corresponding to this enumeration value. | |
| 82 * @return The integer value. | |
| 83 **/ | |
| 84 public int getValue() { | |
| 85 return value; | |
| 86 } | |
| 87 } |