NodeResult.java

/*
 * Copyright 2012 AppSatori s.r.o.
 *
 * 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 eu.appsatori.pipes;

/**
 * The result of task executed in the node which is used to determine next flow of the pipe.
 * 
 * @author <a href="mailto:vladimir.orany@appsatori.eu">Vladimir Orany</a>
 */
public class NodeResult {
	
	static final NodeResult END_RESULT = new NodeResult(PipeType.SERIAL, null, null);
	static final NodeResult RESULT_FAILING = new NodeResult(PipeType.FAIL_HANDLER, null, null);
	static final NodeResult RESULT_STREAMING = new NodeResult(PipeType.STREAMING, null, null);
	
	private final Object result;
	private final Class<? extends Node<?,?>> next;
	private final PipeType type;
	
	static NodeResult create(PipeType type, Class<? extends Node<?,?>> next){
		return create(type, next, null);
	}
	
	static NodeResult create(PipeType type, Class<? extends Node<?,?>> next, Object result){
		if(next == null){
			return END_RESULT;
		}
		return new NodeResult(type, next, result);
	}
	
	private NodeResult(PipeType type, Class<? extends Node<?,?>> next, Object result) {
		this.type = type;
		this.result = result;
		this.next = next;
	}
	
	boolean hasResult(){
		return result != null;
	}
	
	Object getResult() {
		return result;
	}
	
	boolean hasNext(){
		return next != null;
	}

	Class<? extends Node<?,?>> getNext() {
		return next;
	}
	
	PipeType getType() {
		return type;
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((next == null) ? 0 : next.hashCode());
		result = prime * result
				+ ((this.result == null) ? 0 : this.result.hashCode());
		return result;
	}
	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		NodeResult other = (NodeResult) obj;
		if (next == null) {
			if (other.next != null)
				return false;
		} else if (!next.equals(other.next))
			return false;
		if (result == null) {
			if (other.result != null)
				return false;
		} else if (!result.equals(other.result))
			return false;
		return true;
	}
	@Override
	public String toString() {
		return "NodeResult [result=" + result + ", next=" + next + "]";
	}

}