org.statefulj.fsm.Persister Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of statefulj-fsm Show documentation

Finite State Machine with Non-Detereminstic Transitions

There is a newer version: 3.0

/***
 *
 * Copyright 2014 Andrew Hall
 *
 * 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.statefulj.fsm;

import org.statefulj.fsm.model.State;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

/**
 * A Persister is responsible for maintaining the persistence of the current State of the
 * FSM
 *
 * @author Andrew Hall
 *
 */
public interface Persister {

	/**
	 * Returns the current state.  This will not call into the  underlying database
	 *
	 * @param stateful Stateful Entity
	 * @return current State of the Stateful Entity
	 */
	State getCurrent(T stateful);

	/**
	 * Set the current state to the next state.  Will serialize access to the persistence
	 * and ensure that expected current state is indeed the current state.  If not, will throw
	 * a StaleStateException
	 *
	 * @param stateful StatefulEntity
	 * @param current Expected current State of the Stateful Entity
	 * @param next The value of the updated State
	 * @throws StaleStateException thrown if the state value of the Stateful Entity is not equal to the passed in current
	 * value
	 */
	void setCurrent(T stateful, State current, State next) throws StaleStateException;

	/**
	 * Set the Collection of States to be managed by the Persister
	 * @param states Collection of States
	 */
	void setStates(Collection> states);

	/**
	 * Set the Start State
	 * @param startState Start State
	 */
	void setStartState(State startState);
}