BATCH-671: Added a new class, JobParameter, that represents an individual parameter. Also converted BatchStatus and ParameterType typesafe enumerations to java 5 enums.

Author: lucasward

spring-batch-core/src/main/java/org/springframework/batch/core/BatchStatus.java

@@ -16,73 +16,14 @@
 
 package org.springframework.batch.core;
 
-import java.io.ObjectStreamException;
-import java.io.Serializable;
 
 /**
- * Typesafe enumeration representing the status of an artifact within the batch environment. See Effective Java
- * Programming by Joshua Bloch for more details on the pattern used.
- * 
- * A BatchStatus can be safely serialized, however, it should be noted that the pattern can break down if different
- * class loaders load the enumeration.
- * 
- * This class is immutable and therefore thread-safe.
+ * Enumeration representing the status of a an Execution.
  * 
  * @author Lucas Ward
- * @author Greg Kick
  */
 
-public class BatchStatus implements Serializable {
-
-	private static final long serialVersionUID = 1634960297477743037L;
-
-	private final String name;
-
-	private BatchStatus(String name) {
-		this.name = name;
-	}
-
-	private Object readResolve() throws ObjectStreamException {
-		return getStatus(name);
-	}
-
-	public String toString() {
-		return name;
-	}
-
-	public static final BatchStatus COMPLETED = new BatchStatus("COMPLETED");
-
-	public static final BatchStatus STARTED = new BatchStatus("STARTED");
-
-	public static final BatchStatus STARTING = new BatchStatus("STARTING");
-
-	public static final BatchStatus FAILED = new BatchStatus("FAILED");
-
-	public static final BatchStatus STOPPING = new BatchStatus("STOPPING");
-
-	public static final BatchStatus STOPPED = new BatchStatus("STOPPED");
-
-	public static final BatchStatus UNKNOWN = new BatchStatus("UNKNOWN");
-
-	private static final BatchStatus[] VALUES = { STARTING, STARTED, COMPLETED, FAILED, STOPPING, STOPPED, UNKNOWN };
+public enum BatchStatus {
 
-	/**
-	 * Given a string representation of a status, return the appropriate BatchStatus.
-	 * 
-	 * @param statusAsString string representation of a status
-	 * @return a valid BatchStatus or null if the input is null
-	 * @throws IllegalArgumentException if no status matches provided string.
-	 */
-	public static BatchStatus getStatus(String statusAsString) {
-		if (statusAsString == null) {
-			return null;
-		}
-		final String upperCaseStatusAsString = statusAsString.toUpperCase();
-		for (int i = 0; i < VALUES.length; i++) {
-			if (VALUES[i].toString().equals(upperCaseStatusAsString)) {
-				return VALUES[i];
-			}
-		}
-		throw new IllegalArgumentException("The string did not match a valid status.");
-	}
+	COMPLETED, STARTED, STARTING, FAILED, STOPPING, STOPPED, UNKNOWN;
 }

spring-batch-core/src/main/java/org/springframework/batch/core/JobParameter.java

@@ -0,0 +1,112 @@
+/**
+ * 
+ */
+package org.springframework.batch.core;
+
+import java.io.Serializable;
+import java.util.Date;
+
+import org.apache.commons.lang.builder.HashCodeBuilder;
+
+/**
+ * Domain representation of a parameter to a batch job.  Only the following types can be
+ * parameters: String, Long, Date, and Double.
+ * 
+ * @author Lucas Ward
+ * @since 2.0
+ *
+ */
+public class JobParameter implements Serializable{
+	
+	private final Object parameter;
+	private final ParameterType parameterType;
+	
+	/**
+	 * Construct a new JobParameter as a String.
+	 */
+	public JobParameter(String parameter){
+		this.parameter = parameter;
+		parameterType = ParameterType.STRING;
+	}
+	
+	/**
+	 * Construct a new JobParameter as a Long.
+	 * 
+	 * @param parameter
+	 */
+	public JobParameter(Long parameter){
+		this.parameter = parameter;
+		parameterType = ParameterType.LONG;
+	}
+	
+	/**
+	 * Construct a new JobParameter as a Date.
+	 * 
+	 * @param parameter
+	 */
+	public JobParameter(Date parameter) {
+		this.parameter = new Date(parameter.getTime());
+		parameterType = ParameterType.DATE;
+	}
+	
+	/**
+	 * Construct a new JobParameter as a Double.
+	 * 
+	 * @param parameter
+	 */
+	public JobParameter(Double parameter){
+		this.parameter = parameter;
+		parameterType = ParameterType.DOUBLE;
+	}
+	
+	/**
+	 * @return the value contained within this JobParameter.
+	 */
+	public Object getValue(){
+		
+		if(parameter.getClass().isInstance(Date.class)){
+			return new Date(((Date)parameter).getTime());
+		}
+		else{
+			return parameter;
+		}
+	}
+	
+	/**
+	 * @return a ParameterType representing the type of this parameter.
+	 */
+	public ParameterType getType(){
+		return parameterType;
+	}
+	
+	@Override
+	public boolean equals(Object obj) {
+		if(obj instanceof JobParameter == false){
+			return false;
+		}
+		
+		if(this == obj){
+			return true;
+		}
+		
+		JobParameter rhs = (JobParameter)obj;
+		return this.parameter.equals(rhs.parameter);
+	}
+	
+	@Override
+	public String toString() {
+		return parameter.toString();
+	}
+	
+	public int hashCode() {
+		return new HashCodeBuilder(7, 21).append(parameter).toHashCode();
+	}
+	
+	/**
+	 * Enumeration representing the type of a JobParameter. 
+	 */
+	public enum ParameterType{
+		
+		STRING, DATE, LONG, DOUBLE;
+	}
+}