TransitionConfigurer.java

/*
 * Copyright 2015-2016 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.security.SecurityRule.ComparisonType;
import org.springframework.statemachine.transition.Transition;

/**
 * Base {@code TransitionConfigurer} interface for configuring {@link Transition}s.
 *
 * @author Janne Valkealahti
 *
 * @param <T> the type of a transition configurer
 * @param <S> the type of state
 * @param <E> the type of event
 */
public interface TransitionConfigurer<T, 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
	 */
	T source(S source);

	/**
	 * Specify a state this transition should belong to.
	 *
	 * @param state the state {@code S}
	 * @return configurer for chaining
	 */
	T state(S state);

	/**
	 * Specify event {@code E} for this {@link Transition} which will be triggered
	 * by a event trigger.
	 *
	 * @param event the event for transition
	 * @return configurer for chaining
	 */
	T event(E event);

	/**
	 * Specify that this transition is triggered by a time.
	 *
	 * @param period timer period in millis
	 * @return configurer for chaining
	 */
	T timer(long period);

	/**
	 * Specify that this transition is triggered once by a time after a delay.
	 *
	 * @param period timer period in millis
	 * @return configurer for chaining
	 */
	T timerOnce(long period);

	/**
	 * Specify {@link Action} for this {@link Transition}.
	 *
	 * @param action the action
	 * @return configurer for chaining
	 */
	T action(Action<S, E> action);

	/**
	 * Specify {@link Action} for this {@link Transition}.
	 *
	 * @param action the action
	 * @param error action that will be called if any unexpected exception is thrown by the action.
	 * @return configurer for chaining
	 */
	T action(Action<S, E> action, Action<S, E> error);

	/**
	 * Specify a {@link Guard} for this {@link Transition}.
	 *
	 * @param guard the guard
	 * @return configurer for chaining
	 */
	T guard(Guard<S, E> guard);

	/**
	 * Specify a {@link Guard} backed by a SpEL expression for this {@link Transition}.
	 *
	 * @param expression the SpEL expression
	 * @return configurer for chaining
	 */
	T guardExpression(String expression);


	/**
	 * Specify a security attributes for this {@link Transition}.
	 *
	 * @param attributes the security attributes
	 * @param match the match type
	 * @return configurer for chaining
	 */
	T secured(String attributes, ComparisonType match);

	/**
	 * Specify a security expression for this {@link Transition}.
	 *
	 * @param expression the security expression
	 * @return configurer for chaining
	 */
	T secured(String expression);

}