refactor: replace general Exceptions by specific ones

Author: rtaupe

at.siemens.ct.jminizinc.core/src/main/java/at/siemens/ct/jmz/mznparser/Displayable.java

@@ -1,5 +1,5 @@
 /**
- * Copyright Siemens AG, 2016
+ * Copyright Siemens AG, 2016-2017
  * 
  * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  * If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
@@ -19,7 +19,7 @@
  */
 public interface Displayable {
 
-	public List<Constraint> createConstraint(String values) throws Exception;
+  public List<Constraint> createConstraint(String values);
 
 	public List<InfoGUI> getInfo();
 

at.siemens.ct.jminizinc.core/src/main/java/at/siemens/ct/jmz/mznparser/DisplayableBooleanArray.java

@@ -1,5 +1,5 @@
 /**
- * Copyright Siemens AG, 2016
+ * Copyright Siemens AG, 2016-2017
  * 
  * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  * If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
@@ -28,7 +28,7 @@ public DisplayableBooleanArray(String name, SetExpression<Integer> range) {
 	}
 
 	@Override
-	public List<Constraint> createConstraint(String value) throws Exception {
+  public List<Constraint> createConstraint(String value) {
 
 		List<Constraint> constraints = new ArrayList<>();
 		Constraint constraint;
@@ -38,7 +38,8 @@ public List<Constraint> createConstraint(String value) throws Exception {
 
 		if(!(type instanceof RangeExpression))
 		{
-			throw new Exception(String.format("This type of variable: %s cannot be used as index for array", type.use()));
+      throw new UnsupportedOperationException(
+          String.format("This type of variable: %s cannot be used as index for array", type.use()));
 		}
 
 		RangeExpression arrayIndexRange = (RangeExpression) type;

at.siemens.ct.jminizinc.core/src/main/java/at/siemens/ct/jmz/mznparser/DisplayableIntegerArray.java

@@ -1,5 +1,5 @@
 /**
- * Copyright Siemens AG, 2016
+ * Copyright Siemens AG, 2016-2017
  * 
  * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  * If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
@@ -33,15 +33,16 @@ public DisplayableIntegerArray(String name, SetExpression<Integer> range, SetExp
 	}
 
 	@Override
-	public List<Constraint> createConstraint(String value) throws Exception {
+  public List<Constraint> createConstraint(String value) {
 		List<Constraint> constraints = new ArrayList<>();
 
 		String[] integerArrayValues = value.split(",");
 
 		SetExpression<Integer> type = this.getIntegerArray().getRange().get(0);
 		if(!(type instanceof RangeExpression))
 		{
-			throw new Exception(String.format("This type of variable: %s cannot be used as index for array", type.use()));
+      throw new UnsupportedOperationException(
+          String.format("This type of variable: %s cannot be used as index for array", type.use()));
 		}
 		RangeExpression arrayIndexRange = (RangeExpression) type;
 
@@ -54,7 +55,7 @@ public List<Constraint> createConstraint(String value) throws Exception {
 
 			if (integerArrayValues[i] != "Undefined" && !integerArrayValues[i].isEmpty()) {
 				if (!MiniZincElementFactory.isNumeric(integerArrayValues[i]))
-					throw new Exception(
+          throw new UnsupportedOperationException(
 							"Wrong value inserted for variable " + this.getName() + ". His value must be an integer.");
 
 				int variablevalue = Integer.parseInt(integerArrayValues[i]);

at.siemens.ct.jminizinc.core/src/main/java/at/siemens/ct/jmz/mznparser/DisplayableIntegerVariable.java

@@ -1,5 +1,5 @@
 /**
- * Copyright Siemens AG, 2016
+ * Copyright Siemens AG, 2016-2017
  * 
  * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  * If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
@@ -36,15 +36,15 @@ public DisplayableIntegerVariable(String name, SetExpression<Integer> type, Expr
 	}
 
 	@Override
-	public List<Constraint> createConstraint(String value) throws Exception {
+  public List<Constraint> createConstraint(String value) {
 		List<Constraint> constraints = new ArrayList<>();
 		String variableName = this.getName();
 
 		if (value.equals("Undefined") || value.isEmpty())
 			return null;
 
 		if (!MiniZincElementFactory.isNumeric(value))
-			throw new Exception(
+      throw new IllegalArgumentException(
 					"Wrong value inserted for variable " + variableName + ". His value must be an integer.");
 
 		int variableValue = this.parseValue(value);

at.siemens.ct.jminizinc.core/src/main/java/at/siemens/ct/jmz/mznparser/MiniZincCP.java

@@ -1,12 +1,13 @@
 /**
- * Copyright Siemens AG, 2016
+ * Copyright Siemens AG, 2016-2017
  * 
  * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  * If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 package at.siemens.ct.jmz.mznparser;
 
 import java.io.File;
+import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -22,28 +23,26 @@ public class MiniZincCP {
 	private List<Displayable> elementsFromFile;
 
 	/**
-	 * creates an MiniZincCP object according to the .mzn file
-	 * 
-	 * @param mznFile
-	 *            - the .mzn File
-	 * @throws Exception
-	 */
-	public MiniZincCP(File mznFile) throws Exception {
+   * creates an MiniZincCP object according to the .mzn file
+   * 
+   * @param mznFile
+   *            - the .mzn File
+   * @throws IOException 
+   */
+  public MiniZincCP(File mznFile) throws IOException {
 		elementsFromFile = new ArrayList<Displayable>();
 		parseMZN(mznFile);
 	}
 
 	/**
-	 * Parses a .mzn file and populates lists with decision variables and
-	 * constraints
-	 * 
-	 * @param mznFile
-	 *            - the MiniZinc file for the CP (constraint problem)
-	 * @throws Exception
-	 * @throws IllegalAccessException
-	 * @throws IllegalArgumentException
-	 */
-	private void parseMZN(File mznFile) throws Exception {
+   * Parses a .mzn file and populates lists with decision variables and
+   * constraints
+   * 
+   * @param mznFile
+   *            - the MiniZinc file for the CP (constraint problem)
+   * @throws IOException 
+   */
+  private void parseMZN(File mznFile) throws IOException {
 		List<String> linesFromMznFile = FileUtils.readLines(mznFile);
 		Displayable mznElement;
 

at.siemens.ct.jminizinc.core/src/main/java/at/siemens/ct/jmz/mznparser/MiniZincElementFactory.java

@@ -1,5 +1,5 @@
 /**
- * Copyright Siemens AG, 2016
+ * Copyright Siemens AG, 2016-2017
  * 
  * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  * If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
@@ -28,7 +28,7 @@ public class MiniZincElementFactory {
 	private static final String RANGE_SEPARATOR = "..";
 	private List<BasicTypeInst<?>> listWithParameters = new ArrayList<BasicTypeInst<?>>();
 
-	public Displayable getElementFromLine(String line) throws Exception {
+  public Displayable getElementFromLine(String line) {
 
 		String instantiation, name, type, defaultValue, arrayIndex;
 		for (PossibleVariablesDeclarationsPatterns patternAsString : PossibleVariablesDeclarationsPatterns.values()) {
@@ -52,7 +52,7 @@ public Displayable getElementFromLine(String line) throws Exception {
 					if (arrayIndex.contains(RANGE_SEPARATOR)) {
 						arraySize = createRange(arrayIndex);
 					} else {
-						throw new Exception("Unimplemented! define array range as m..n!");
+            throw new UnsupportedOperationException("Unimplemented! define array range as m..n!");
 					}
 
 					if (instantiation != null && instantiation.equals(VAR_TYPE) && defaultValue == null) {

at.siemens.ct.jminizinc.diag/src/main/java/at/siemens/ct/jmz/diag/AbstractConflictDetection.java

@@ -38,14 +38,14 @@ public AbstractConflictDetection(String mznFullFileName, Collection<? extends El
 
 	// TODO: Shall use Set instead of List?
 	/**
-	 * Search for a conflict set in a given set
-	 * 
-	 * @param constraintsSetC
-	 *            a set of constraint
-	 * @return a conflict set
-	 * @throws Exception
-	 */
-	public abstract List<Constraint> getMinConflictSet(List<Constraint> constraintsSetC) throws Exception;
+   * Search for a conflict set in a given set
+   * 
+   * @param constraintsSetC
+   *            a set of constraint
+   * @return a conflict set
+   * @throws DiagnosisException 
+   */
+  public abstract List<Constraint> getMinConflictSet(List<Constraint> constraintsSetC) throws DiagnosisException;
 
 	public static List<Constraint> appendSets(List<Constraint> CS1, List<Constraint> CS2) {
 		List<Constraint> reunion = new ArrayList<>(CS1);

at.siemens.ct.jminizinc.diag/src/main/java/at/siemens/ct/jmz/diag/ConsistencyChecker.java

@@ -7,6 +7,7 @@
 package at.siemens.ct.jmz.diag;
 
 import java.io.File;
+import java.io.IOException;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
@@ -41,11 +42,11 @@ private void initialization() {
 	}
 
 	/** Determines the consistency of a mzn file (Background KB) 
-	 * @param mznFile - the mzn file which contains the background KB
-	 * @return true if is consistent
-	 * @throws Exception
-	 */
-	public boolean isConsistent(File mznFile) throws Exception {
+   * @param mznFile - the mzn file which contains the background KB
+   * @return true if is consistent
+   * @throws DiagnosisException 
+   */
+  public boolean isConsistent(File mznFile) throws DiagnosisException {
 		initialization();
 		modelBuilder.reset();
 
@@ -56,7 +57,7 @@ public boolean isConsistent(File mznFile) throws Exception {
     return (isSolverResultConsistent(res));
   }
 
-  public boolean isConsistent(Collection<? extends Element> fixedElements) throws Exception {
+  public boolean isConsistent(Collection<? extends Element> fixedElements) throws DiagnosisException {
     initialization();
     modelBuilder.reset();
 
@@ -67,17 +68,17 @@ public boolean isConsistent(Collection<? extends Element> fixedElements) throws
 	}
 
 	/** Determines the consistency of given constraints set with the background KB
-	 * @param constraintsSet - the given constraints set
-	 * @param mznFile - the mzn file which contains the background KB
-	 * @return true if the given set is consistent with background KB
-	 * @throws Exception
-	 */
-	public boolean isConsistent(List<Constraint> constraintsSet, File mznFile) throws Exception {
+   * @param constraintsSet - the given constraints set
+   * @param mznFile - the mzn file which contains the background KB
+   * @return true if the given set is consistent with background KB
+   * @throws DiagnosisException 
+   */
+  public boolean isConsistent(List<Constraint> constraintsSet, File mznFile) throws DiagnosisException {
     return isConsistent(constraintsSet, Collections.emptySet(), mznFile);
   }
 
   public boolean isConsistent(List<Constraint> constraintsSet, Collection<? extends Element> fixedModel, File mznFile)
-      throws Exception {
+      throws DiagnosisException {
 		initialization();
 		modelBuilder.reset();
 
@@ -94,7 +95,8 @@ public boolean isConsistent(List<Constraint> constraintsSet, Collection<? extend
 		return (isSolverResultConsistent(res));
 	}
 
-	public boolean isConsistent(List<Constraint> constraintsSet, List<Element> decisionVariables) throws Exception {
+  public boolean isConsistent(List<Constraint> constraintsSet, List<Element> decisionVariables)
+      throws DiagnosisException {
 		initialization();
 		modelBuilder.reset();
 		modelBuilder.add(constraintsSet);
@@ -109,15 +111,21 @@ private boolean isSolverResultConsistent(String result) {
 		return res;
 	}
 
-	private String callExecutor() throws Exception {
-		executor.startProcess();
-		executor.waitForSolution();
+  private String callExecutor() throws DiagnosisException {
+    try {
+      executor.startProcess();
+      executor.waitForSolution();
+    } catch (IOException e) {
+      throw new DiagnosisException("Solver could not be started", e);
+    } catch (InterruptedException e) {
+    }
+
 		int lastExitCode = executor.getLastExitCode();
 		if (lastExitCode != IExecutor.EXIT_CODE_SUCCESS) {
 			if (executor.getLastSolverErrors().isEmpty()) {
-				throw new Exception("An error occured while running the solver. Some libraries are missing.");
+        throw new DiagnosisException("An error occured while running the solver. Some libraries are missing.");
 			} else {
-				throw new Exception("An error occured while running the solver." + executor.getLastSolverErrors());
+        throw new DiagnosisException("An error occured while running the solver." + executor.getLastSolverErrors());
 			}
 		}
 

at.siemens.ct.jminizinc.diag/src/main/java/at/siemens/ct/jmz/diag/DiagnoseProgressCallback.java

@@ -1,5 +1,5 @@
 /**
- * Copyright Siemens AG, 2016
+ * Copyright Siemens AG, 2016-2017
  * 
  * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  * If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
@@ -31,7 +31,7 @@ public interface DiagnoseProgressCallback {
 	public void ignoredDiagnosis(List<Constraint> diagnosis, DiagnosisMetadata diagnosisMetadata);
 
 	public void displayPartOfDiagnosis(List<Constraint> diagnosis, List<Constraint> inputConflictSet, String nodeIndex,
-			String indent) throws Exception;
+      String indent);
 
 	public void displayPreferredDiagnosis(List<Constraint> diagnosis, List<Constraint> inputConflictSet);
 

at.siemens.ct.jminizinc.diag/src/main/java/at/siemens/ct/jmz/diag/DiagnosisException.java

@@ -0,0 +1,26 @@
+/**
+ * Copyright Siemens AG, 2017
+ * 
+ * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
+ * If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package at.siemens.ct.jmz.diag;
+
+/**
+ * 
+ * @author Copyright Siemens AG, 2017
+ *
+ */
+public class DiagnosisException extends Exception {
+
+  private static final long serialVersionUID = 1620929690602094866L;
+
+  public DiagnosisException(String message) {
+    super(message);
+  }
+
+  public DiagnosisException(String message, Throwable cause) {
+    super(message, cause);
+  }
+
+}