State.java

package de.uniluebeck.itm.wsn.drivers.core.operation;

import java.util.Arrays;

/**
 * Enum for all states of an <code>OperationRunnable</code>.
 * 
 * @author Malte Legenhausen
 */
public enum State {
	
	/**
	 * The <code>OperationRunnable</code> is waiting in the execution queue.
	 */
	WAITING("Waiting"),
	
	/**
	 * The <code>OperationRunnable</code> is currently running.
	 */
	RUNNING("Running"),
	
	/**
	 * The <code>OperationRunnable</code> has been canceled.
	 */
	CANCELED("Canceled"),
	
	/**
	 * The <code>OperationRunnable</code> failed with an exception.
	 */
	FAILED("Failed"),
	
	/**
	 * The <code>OperationRunnable</code> reached the timeout.
	 */
	TIMEOUT("Timeout"),
	
	/**
	 * The <code>OperationRunnable</code> is done.
	 */
	DONE("Done");
	
	private static final State[] FINISH_STATES = {State.DONE, State.FAILED, State.CANCELED, State.TIMEOUT};
	
	/**
	 * The name of the state.
	 */
	private final String name;
	
	/**
	 * Constructor.
	 * 
	 * @param name The name of the state.
	 */
	private State(final String name) {
		this.name = name;
	}
	
	/**
	 * Getter for the state name.
	 * 
	 * @return The name as <code>String</code>.
	 */
	public String getName() {
		return name;
	}
	
	/**
	 * Returns true when this state is equals to DONE, FAILED or CANCELED else false.
	 *
	 * @param state the state to check
	 * @return A boolean for representing a finished state.
	 */
	public static boolean isFinishState(final State state) {
		return state != null && Arrays.asList(FINISH_STATES).contains(state);
	}
	
	/**
	 * Determine the State by his name.
	 * 
	 * @param name The name of the state that has to be retuned.
	 * @return The state with the given name or null.
	 */
	public static State fromName(final String name) {
		for (State state : State.values()) {
			if (state.getName().equals(name)) {
				return state;
			}
		}
		throw new IllegalArgumentException("No constant with name " + name + " found");
	}
	
	/**
	 * Determine the State by his String representation.
	 * 
	 * @param value The string representing the State.
	 * @return The appropriate String.
	 */
	public static State fromString(final String value) {
		return State.valueOf(value);
	}
}