ShellStatus.java

/*
 * Copyright 2011-2012 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.shell.event;


/**
 * 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 message;
	}

	public Status getStatus() {
		return status;
	}

	public final ParseResult getParseResult() {
		return parseResult;
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((message == null) ? 0 : message.hashCode());
		result = prime * result
				+ ((parseResult == null) ? 0 : parseResult.hashCode());
		result = prime * result + ((status == null) ? 0 : 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;
		ShellStatus other = (ShellStatus) obj;
		if (message == null) {
			if (other.message != null)
				return false;
		} else if (!message.equals(other.message))
			return false;
		if (parseResult == null) {
			if (other.parseResult != null)
				return false;
		} else if (!parseResult.equals(other.parseResult))
			return false;
		if (status == null) {
			if (other.status != null)
				return false;
		} else if (!status.equals(other.status))
			return false;
		return true;
	}
}