PseudoStateContext.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.state;

/**
 * Context object using in {@link PseudoStateListener}.
 * 
 * @author Janne Valkealahti
 *
 * @param <S> the type of state
 * @param <E> the type of event
 */
public interface PseudoStateContext<S, E> {

	/**
	 * Gets the pseudo state.
	 *
	 * @return the pseudo state
	 */
	PseudoState<S, E> getPseudoState();
	
	/**
	 * Gets the pseudo action.
	 *
	 * @return the pseudo action
	 */
	PseudoAction getPseudoAction();

	/**
	 * The PseudoAction enumeration.
	 */
	public enum PseudoAction {
		
		/**
		 * Indication that states has been joined.
		 */
		JOIN_COMPLETED;
	}
}