StateMachineFactory.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;

import org.springframework.statemachine.StateMachine;

import java.util.UUID;

/**
 * {@code StateMachineFactory} is a strategy interface building {@link StateMachine}s.
 *
 * @author Janne Valkealahti
 *
 * @param <S> the type of state
 * @param <E> the type of event
 */
public interface StateMachineFactory<S, E> {

	/**
	 * Build a new {@link StateMachine} instance.
	 *
	 * @return a new state machine instance.
	 */
	StateMachine<S, E> getStateMachine();

	/**
	 * Build a new {@link StateMachine} instance
	 * with a given machine id.
	 *
	 * @param machineId the machine id
	 * @return a new state machine instance.
	 */
	StateMachine<S, E> getStateMachine(String machineId);

	/**
	 * Build a new {@link StateMachine} instance
	 * with a given machine uuid.
	 *
	 * @param uuid to be used internally
	 * @return a new state machine instance.
	 */
	StateMachine<S, E> getStateMachine(UUID uuid);
}