ShellStatus.java

package vnet.sms.common.shell.springshell.event;

import vnet.sms.common.shell.springshell.ParseResult;

/**
 * Represents the different states that a shell can legally be in.
 * 
 * <p>
 * There is no "shut down" state because the shell would have been terminated by
 * that stage and potentially garbage collected. There is no guarantee that a
 * shell implementation will necessarily publish every state.
 * 
 * @author Ben Alex
 * @author Stefan Schmidt
 * @since 1.0
 */
public class ShellStatus {

	// Fields
	private final Status	status;

	private String	     message	= "";

	private ParseResult	 parseResult;

	public enum Status {
		STARTING, STARTED, USER_INPUT, PARSING, EXECUTING, EXECUTION_RESULT_PROCESSING, EXECUTION_SUCCESS, EXECUTION_FAILED, SHUTTING_DOWN
	}

	ShellStatus(final Status status) {
		this.status = status;
	}

	ShellStatus(final Status status, final String msg,
	        final ParseResult parseResult) {
		this.status = status;
		this.message = msg;
		this.parseResult = parseResult;
	}

	public String getMessage() {
		return this.message;
	}

	public Status getStatus() {
		return this.status;
	}

	public final ParseResult getParseResult() {
		return this.parseResult;
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result
		        + ((this.message == null) ? 0 : this.message.hashCode());
		result = prime
		        * result
		        + ((this.parseResult == null) ? 0 : this.parseResult.hashCode());
		result = prime * result
		        + ((this.status == null) ? 0 : this.status.hashCode());
		return result;
	}

	@Override
	public boolean equals(final Object obj) {
		if (this == obj) {
			return true;
		}
		if (obj == null) {
			return false;
		}
		if (getClass() != obj.getClass()) {
			return false;
		}
		final ShellStatus other = (ShellStatus) obj;
		if (this.message == null) {
			if (other.message != null) {
				return false;
			}
		} else if (!this.message.equals(other.message)) {
			return false;
		}
		if (this.parseResult == null) {
			if (other.parseResult != null) {
				return false;
			}
		} else if (!this.parseResult.equals(other.parseResult)) {
			return false;
		}
		if (this.status == null) {
			if (other.status != null) {
				return false;
			}
		} else if (!this.status.equals(other.status)) {
			return false;
		}
		return true;
	}
}