1 /*******************************************************************************
2 * SAT4J: a SATisfiability library for Java Copyright (C) 2004-2008 Daniel Le Berre
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 *******************************************************************************/
28 package org.sat4j;
29
30 /**
31 * Enumeration allowing to manage easily exit code for the SAT and PB
32 * Competitions.
33 *
34 * @author leberre
35 *
36 */
37 public class ExitCode {
38
39 public static final ExitCode OPTIMUM_FOUND = new ExitCode(30, "OPTIMUM FOUND");
40 public static final ExitCode SATISFIABLE = new ExitCode(10, "SATISFIABLE");
41 public static final ExitCode UNKNOWN = new ExitCode(0, "UNKNOWN");
42 public static final ExitCode UNSATISFIABLE = new ExitCode(20,"UNSATISFIABLE");
43
44 /** value of the exit code. */
45 private final int value;
46
47 /** alternative textual representation of the exit code. */
48 private final String str;
49
50 /**
51 * creates an exit code with a given value and an alternative textual
52 * representation.
53 *
54 * @param i
55 * the value of the exit code
56 * @param str
57 * the alternative textual representation
58 */
59 private ExitCode(final int i, final String str) {
60 this.value = i;
61 this.str = str;
62 }
63
64 /**
65 * @return the exit code value
66 */
67 public int value() {
68 return value;
69 }
70
71 /**
72 * @return the name of the enum or the alternative textual representation if
73 * any.
74 */
75 @Override
76 public String toString() {
77 return str;
78 }
79 }