org.jallaby.execution.Transition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jallaby-core Show documentation

The Jallaby Hierarchical State Machine Container Core Module

The newest version!

/*
 * Copyright 2022, The Jallaby Development Team
 *
 * 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.jallaby.execution;

import java.util.List;

/**
 * Transitions of a {@link StateMachine}'s {@link State}s implement this interface.
 * 
 * @author Matthias Rothe
 */
public interface Transition {
	
	/**
	 * @return the list of {@link TransitionGuard}s guarding this transition
	 */
	List getTransitionGuards();
	
	/**
	 * @return the list of {@link TransitionActionGroup}s to be executed during this transition
	 */
	List getTransitionActionGroups();
	
	/**
	 * @return the {@link StateInfo} describing how many states to exit and which states to enter
	 * by executing this transition
	 */
	StateInfo getTargetStateInfo();
}