1 /*
2 * SAT4J: a SATisfiability library for Java Copyright (C) 2004-2006 Daniel Le Berre
3 *
4 * Based on the original minisat specification from:
5 *
6 * An extensible SAT solver. Niklas E?n and Niklas S?rensson. Proceedings of the
7 * Sixth International Conference on Theory and Applications of Satisfiability
8 * Testing, LNCS 2919, pp 502-518, 2003.
9 *
10 * This library is free software; you can redistribute it and/or modify it under
11 * the terms of the GNU Lesser General Public License as published by the Free
12 * Software Foundation; either version 2.1 of the License, or (at your option)
13 * any later version.
14 *
15 * This library is distributed in the hope that it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
18 * details.
19 *
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this library; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 *
24 */
25 package org.sat4j;
26
27 /**
28 * Enumeration allowing to manage easily exit code for the SAT and PB
29 * Competitions.
30 *
31 * @author leberre
32 *
33 */
34 public enum ExitCode {
35 OPTIMUM_FOUND(30, "OPTIMUM FOUND"), SATISFIABLE(10), UNKNOWN(0), UNSATISFIABLE( //$NON-NLS-1$
36 20);
37
38 /** value of the exit code. */
39 private final int value;
40
41 /** alternative textual representation of the exit code. */
42 private final String str;
43
44 /**
45 * creates an exit code with a given value.
46 *
47 * @param i
48 * the value of the exit code
49 */
50 ExitCode(final int value) {
51 this.value = value;
52 str = null;
53 }
54
55 /**
56 * creates an exit code with a given value and an alternative textual
57 * representation.
58 *
59 * @param i
60 * the value of the exit code
61 * @param str
62 * the alternative textual representation
63 */
64 ExitCode(final int i, final String str) {
65 this.value = i;
66 this.str = str;
67 }
68
69 /**
70 * @return the exit code value
71 */
72 public int value() {
73 return value;
74 }
75
76 /**
77 * @return the name of the enum or the alternative textual representation if
78 * any.
79 */
80 @Override
81 public String toString() {
82 final String result;
83 if (str == null) {
84 result = super.toString();
85 } else {
86 result = str;
87 }
88 return result;
89 }
90 }