FlowExecutionOutcome.java

/*
 * Copyright 2004-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.webflow.execution;

import org.springframework.core.style.ToStringCreator;
import org.springframework.webflow.core.collection.AttributeMap;
import org.springframework.webflow.core.collection.CollectionUtils;

/**
 * An outcome returned by a flow execution when it ends.
 * 
 * @author Keith Donald
 */
public class FlowExecutionOutcome {

	private String id;

	private AttributeMap<Object> output;

	/**
	 * Creates a new flow execution outcome
	 * @param id the outcome id
	 * @param output the output returned by the execution
	 */
	public FlowExecutionOutcome(String id, AttributeMap<Object> output) {
		super();
		this.id = id;
		this.output = (output != null ? output : CollectionUtils.EMPTY_ATTRIBUTE_MAP);
	}

	/**
	 * Return the outcome identifier.
	 * @return the outcome that was reached by the flow execution
	 */
	public String getId() {
		return id;
	}

	/**
	 * Returns the output returned by the flow execution.
	 * @return the output that was returned
	 */
	public AttributeMap<Object> getOutput() {
		return output;
	}

	public String toString() {
		return new ToStringCreator(this).append("id", id).append("output", output).toString();
	}

}