1 /*******************************************************************************
2 * SAT4J: a SATisfiability library for Java Copyright (C) 2004, 2012 Artois University and CNRS
3 *
4 * All rights reserved. This program and the accompanying materials
5 * are made available under the terms of the Eclipse Public License v1.0
6 * which accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
8 *
9 * Alternatively, the contents of this file may be used under the terms of
10 * either the GNU Lesser General Public License Version 2.1 or later (the
11 * "LGPL"), in which case the provisions of the LGPL are applicable instead
12 * of those above. If you wish to allow use of your version of this file only
13 * under the terms of the LGPL, and not to allow others to use your version of
14 * this file under the terms of the EPL, indicate your decision by deleting
15 * the provisions above and replace them with the notice and other provisions
16 * required by the LGPL. If you do not delete the provisions above, a recipient
17 * may use your version of this file under the terms of the EPL or the LGPL.
18 *
19 * Based on the original MiniSat specification from:
20 *
21 * An extensible SAT solver. Niklas Een and Niklas Sorensson. Proceedings of the
22 * Sixth International Conference on Theory and Applications of Satisfiability
23 * Testing, LNCS 2919, pp 502-518, 2003.
24 *
25 * See www.minisat.se for the original solver in C++.
26 *
27 * Contributors:
28 * CRIL - initial API and implementation
29 *******************************************************************************/
30 package org.sat4j;
31
32 /**
33 * Enumeration allowing to manage easily exit code for the SAT and PB
34 * Competitions.
35 *
36 * @author leberre
37 *
38 */
39 public final class ExitCode {
40
41 public static final ExitCode OPTIMUM_FOUND = new ExitCode(30,
42 "OPTIMUM FOUND");
43 public static final ExitCode UPPER_BOUND = new ExitCode(30, "UPPER BOUND");
44 public static final ExitCode SATISFIABLE = new ExitCode(10, "SATISFIABLE");
45 public static final ExitCode UNKNOWN = new ExitCode(0, "UNKNOWN");
46 public static final ExitCode UNSATISFIABLE = new ExitCode(20,
47 "UNSATISFIABLE");
48
49 /** value of the exit code. */
50 private final int value;
51
52 /** alternative textual representation of the exit code. */
53 private final String str;
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 private 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 this.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 return this.str;
83 }
84 }