ChoiceTransitionConfigurer.java

/*
 * Copyright 2015 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.statemachine.config.configurers;

import org.springframework.statemachine.action.Action;
import org.springframework.statemachine.config.builders.StateMachineTransitionConfigurer;
import org.springframework.statemachine.config.common.annotation.AnnotationConfigurerBuilder;
import org.springframework.statemachine.guard.Guard;
import org.springframework.statemachine.transition.Transition;

/**
 * {@code TransitionConfigurer} interface for configuring {@link Transition}
 * from a choice pseudo state.
 *
 * @author Janne Valkealahti
 *
 * @param <S> the type of state
 * @param <E> the type of event
 */
public interface ChoiceTransitionConfigurer<S, E>
		extends AnnotationConfigurerBuilder<StateMachineTransitionConfigurer<S, E>> {

	/**
	 * Specify a source state {@code S} for this {@link Transition}.
	 *
	 * @param source the source state {@code S}
	 * @return configurer for chaining
	 */
	ChoiceTransitionConfigurer<S, E> source(S source);

	/**
	 * Specify a target state {@code S} as a first choice.
	 * This must be set.
	 * <p>In normal if/else if/else this would represent if.</p>
	 *
	 * @param target the target state
	 * @param guard the guard for this choice
	 * @return configurer for chaining
	 */
	ChoiceTransitionConfigurer<S, E> first(S target, Guard<S, E> guard);

	/**
	 * Specify a target state {@code S} as a first choice associating an
	 * {@link Action} to outgoing vertex. This must be set.
	 * <p>
	 * In normal if/else if/else this would represent if.
	 * </p>
	 *
	 * @param target the target state
	 * @param guard the guard for this choice
	 * @param action the action
	 * @return configurer for chaining
	 */
	ChoiceTransitionConfigurer<S, E> first(S target, Guard<S, E> guard, Action<S, E> action);

	/**
	 * Specify a target state {@code S} as a first choice associating an
	 * {@link Action} to outgoing vertex. This must be set.
	 * <p>
	 * In normal if/else if/else this would represent if.
	 * </p>
	 *
	 * @param target the target state
	 * @param guard the guard for this choice
	 * @param action the action
	 * @param error action that will be called if any unexpected exception is thrown by the action.
	 * @return configurer for chaining
	 */
	ChoiceTransitionConfigurer<S, E> first(S target, Guard<S, E> guard, Action<S, E> action, Action<S, E> error);

	/**
	 * Specify a target state {@code S} as a then choice.
	 * This is optional. Multiple thens will preserve order.
	 * <p>In normal if/else if/else this would represent else if.</p>
	 *
	 * @param target the target state
	 * @param guard the guard for this choice
	 * @return configurer for chaining
	 */
	ChoiceTransitionConfigurer<S, E> then(S target, Guard<S, E> guard);

	/**
	 * Specify a target state {@code S} as a then choice associating an
	 * {@link Action} to outgoing vertex. This is optional. Multiple thens
	 * will preserve order.
	 * <p>In normal if/else if/else this would represent else if.</p>
	 *
	 * @param target the target state
	 * @param guard the guard for this choice
	 * @param action the action
	 * @return configurer for chaining
	 */
	ChoiceTransitionConfigurer<S, E> then(S target, Guard<S, E> guard, Action<S, E> action);

	/**
	 * Specify a target state {@code S} as a then choice associating an
	 * {@link Action} to outgoing vertex. This is optional. Multiple thens
	 * will preserve order.
	 * <p>In normal if/else if/else this would represent else if.</p>
	 *
	 * @param target the target state
	 * @param guard the guard for this choice
	 * @param action the action
	 * @param error action that will be called if any unexpected exception is thrown by the action.
	 * @return configurer for chaining
	 */
	ChoiceTransitionConfigurer<S, E> then(S target, Guard<S, E> guard, Action<S, E> action, Action<S, E> error);

	/**
	 * Specify a target state {@code S} as a last choice.
	 * This must be set.
	 * <p>In normal if/else if/else this would represent else.</p>
	 *
	 * @param target the target state
	 * @return configurer for chaining
	 */
	ChoiceTransitionConfigurer<S, E> last(S target);

	/**
	 * Specify a target state {@code S} as a last choice associating an
	 * {@link Action} to outgoing vertex. This must be set.
	 * <p>In normal if/else if/else this would represent else.</p>
	 *
	 * @param target the target state
	 * @param action the action
	 * @return configurer for chaining
	 */
	ChoiceTransitionConfigurer<S, E> last(S target, Action<S, E> action);

	/**
	 * Specify a target state {@code S} as a last choice associating an
	 * {@link Action} to outgoing vertex. This must be set.
	 * <p>In normal if/else if/else this would represent else.</p>
	 *
	 * @param target the target state
	 * @param action the action
	 * @param error action that will be called if any unexpected exception is thrown by the action.
	 * @return configurer for chaining
	 */
	ChoiceTransitionConfigurer<S, E> last(S target, Action<S, E> action, Action<S, E> error);
}