[CIShell-SVN] SF.net SVN: cishell:[1092] trunk/core/org.cishell.framework/src/org/cishell /framework/algorithm

[<pat...@us...>]

Revision: 1092
          http://cishell.svn.sourceforge.net/cishell/?rev=1092&view=rev
Author:   pataphil
Date:     2010-07-21 03:49:14 +0000 (Wed, 21 Jul 2010)

Log Message:
-----------
* Added AlgorithmCreationCanceledException and AlgorithmCreationFailedException with the intent of eventually modifying AlgorithmFactory/etc.
* Marked up AlgorithmFactory with intentions.

Modified Paths:
--------------
    trunk/core/org.cishell.framework/src/org/cishell/framework/algorithm/AlgorithmExecutionException.java
    trunk/core/org.cishell.framework/src/org/cishell/framework/algorithm/AlgorithmFactory.java

Added Paths:
-----------
    trunk/core/org.cishell.framework/src/org/cishell/framework/algorithm/AlgorithmCreationCanceledException.java
    trunk/core/org.cishell.framework/src/org/cishell/framework/algorithm/AlgorithmCreationFailedException.java

Added: trunk/core/org.cishell.framework/src/org/cishell/framework/algorithm/AlgorithmCreationCanceledException.java
===================================================================
--- trunk/core/org.cishell.framework/src/org/cishell/framework/algorithm/AlgorithmCreationCanceledException.java	                        (rev 0)
+++ trunk/core/org.cishell.framework/src/org/cishell/framework/algorithm/AlgorithmCreationCanceledException.java	2010-07-21 03:49:14 UTC (rev 1092)
@@ -0,0 +1,22 @@
+package org.cishell.framework.algorithm;
+
+// TODO: Make this a regular Exception (not RuntimeException).
+public class AlgorithmCreationCanceledException extends RuntimeException {
+	private static final long serialVersionUID = 9017277008277139930L;
+
+	public AlgorithmCreationCanceledException(String message, Throwable exception) {
+		super(message, exception);
+	}
+	
+	public AlgorithmCreationCanceledException(Throwable exception) {
+		super(exception);
+	}
+	
+	public AlgorithmCreationCanceledException(String message) {
+		super(message);
+	}
+
+	public AlgorithmCreationCanceledException() {
+		this("Algorithm canceled by user.");
+	}
+}

Added: trunk/core/org.cishell.framework/src/org/cishell/framework/algorithm/AlgorithmCreationFailedException.java
===================================================================
--- trunk/core/org.cishell.framework/src/org/cishell/framework/algorithm/AlgorithmCreationFailedException.java	                        (rev 0)
+++ trunk/core/org.cishell.framework/src/org/cishell/framework/algorithm/AlgorithmCreationFailedException.java	2010-07-21 03:49:14 UTC (rev 1092)
@@ -0,0 +1,22 @@
+package org.cishell.framework.algorithm;
+
+// TODO: Make this a regular Exception (not RuntimeException).
+public class AlgorithmCreationFailedException extends RuntimeException {
+	private static final long serialVersionUID = 9017277008277139930L;
+
+	public AlgorithmCreationFailedException(String message, Throwable exception) {
+		super(message, exception);
+	}
+	
+	public AlgorithmCreationFailedException(Throwable exception) {
+		super(exception);
+	}
+	
+	public AlgorithmCreationFailedException(String message) {
+		super(message);
+	}
+
+	public AlgorithmCreationFailedException() {
+		this("Algorithm canceled by user.");
+	}
+}

Modified: trunk/core/org.cishell.framework/src/org/cishell/framework/algorithm/AlgorithmExecutionException.java
===================================================================
--- trunk/core/org.cishell.framework/src/org/cishell/framework/algorithm/AlgorithmExecutionException.java	2010-07-21 00:47:14 UTC (rev 1091)
+++ trunk/core/org.cishell.framework/src/org/cishell/framework/algorithm/AlgorithmExecutionException.java	2010-07-21 03:49:14 UTC (rev 1092)
@@ -16,8 +16,7 @@
 /**
  * An exception which is thrown when an error occurs in the process of executing
  * an {@link Algorithm}
- * 
- * @author Bruce Herr (bh...@bh...)
+ *
  */
 public class AlgorithmExecutionException extends Exception {
 	private static final long serialVersionUID = 9017277008277139930L;

Modified: trunk/core/org.cishell.framework/src/org/cishell/framework/algorithm/AlgorithmFactory.java
===================================================================
--- trunk/core/org.cishell.framework/src/org/cishell/framework/algorithm/AlgorithmFactory.java	2010-07-21 00:47:14 UTC (rev 1091)
+++ trunk/core/org.cishell.framework/src/org/cishell/framework/algorithm/AlgorithmFactory.java	2010-07-21 03:49:14 UTC (rev 1092)
@@ -51,6 +51,9 @@
      *                   standard CIShell services
      * @return An <code>Algorithm</code> primed for execution
      */
+	/* TODO: Add AlgorithmCreationCanceledException and AlgorithmCreationFailedException to
+	 *  the signature, and update the entire code base to conform to it.
+	 */
     public Algorithm createAlgorithm(
     		Data[] data, Dictionary<String, Object> parameters, CIShellContext context);
 }


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.