org.requirementsascode.builder.FlowlessConditionPart Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of requirementsascodecore Show documentation
Enables you to define and run executable use case specifications, in your code.
There is a newer version: 2.0
Show newest version
package org.requirementsascode.builder;

import static org.requirementsascode.builder.FlowlessStepPart.flowlessStepPart;

import java.util.Objects;
import java.util.function.Supplier;

import org.requirementsascode.Condition;
import org.requirementsascode.Model;
import org.requirementsascode.ModelRunner;

/**
 * Part used by the {@link ModelBuilder} to build a {@link Model}. Wraps
 * {@link StepPart}.
 * 
 * @author b_muth
 */
public class FlowlessConditionPart {
	private final UseCasePart useCasePart;
	private final Condition optionalCondition;
	private final long flowlessStepCounter;
	private final String autoIncrementedStepName;

	private FlowlessConditionPart(Condition optionalCondition, UseCasePart useCasePart, long flowlessStepCounter) {
		this.optionalCondition = optionalCondition;
		this.useCasePart = Objects.requireNonNull(useCasePart);
		this.flowlessStepCounter = flowlessStepCounter;
		this.autoIncrementedStepName = "S" + flowlessStepCounter;
	}

	static FlowlessConditionPart flowlessConditionPart(Condition optionalCondition, UseCasePart useCasePart, long flowlessStepCounter) {
		return new FlowlessConditionPart(optionalCondition, useCasePart, flowlessStepCounter);
	}

	/**
	 * Creates a named step.
	 * 
	 * @param stepName the name of the created step
	 * @return the created step part
	 */
	public FlowlessStepPart step(final String stepName) {
		FlowlessStepPart flowlessStepPart = flowlessStepPart(stepName, useCasePart, optionalCondition,
			flowlessStepCounter);
		return flowlessStepPart;
	}

	/**
	 * Defines the type of user commands that this step accepts. Commands of this
	 * type can cause a system reaction.
	 *
	 * 
	 * Given that the step's condition is true, the system reacts to objects that
	 * are instances of the specified class or instances of any direct or indirect
	 * subclass of the specified class.
	 *
	 * @param commandClass the class of commands the system reacts to in this step
	 * @param           the type of the class
	 * @return the created user part of this step
	 */
	public  FlowlessUserPart user(Class commandClass) {
		FlowlessUserPart flowlessUserPart = step(autoIncrementedStepName).user(commandClass);
		return flowlessUserPart;
	}

	/**
	 * Defines the type of messages or exceptions that will cause a system reaction,
	 * given that the condition is fulfilled.
	 *
	 * 
	 * Given that the step's condition is true, the system reacts to objects that
	 * are instances of the specified class or instances of any direct or indirect
	 * subclass of the specified class.
	 *
	 * @param messageClass the class of messages the system reacts to
	 * @param           the type of the class
	 * @return the created user part of this step
	 */
	public  FlowlessUserPart on(Class messageClass) {
		FlowlessUserPart flowlessUserPart = step(autoIncrementedStepName).on(messageClass);
		return flowlessUserPart;
	}

	/**
	 * Defines an "autonomous system reaction", meaning the system will react
	 * without needing a message provided via {@link ModelRunner#reactTo(Object)}.
	 *
	 * @param systemReaction the autonomous system reaction
	 * @return the created system part of this step
	 */
	public FlowlessSystemPart system(Runnable systemReaction) {
		FlowlessSystemPart flowlessSystemPart = step(autoIncrementedStepName).system(systemReaction);
		return flowlessSystemPart;
	}

	/**
	 * Defines an "autonomous system reaction", meaning the system will react
	 * without needing a message provided via {@link ModelRunner#reactTo(Object)}.
	 * After executing the system reaction, the runner will publish the returned
	 * event.
	 *
	 * @param systemReaction the autonomous system reaction, that returns a single
	 *                       event to be published.
	 * @return the created system part of this step
	 */
	public FlowlessSystemPart systemPublish(Supplier systemReaction) {
		FlowlessSystemPart flowlessSystemPart = step(autoIncrementedStepName).systemPublish(systemReaction);
		return flowlessSystemPart;
	}

	Condition getOptionalCondition() {
		return optionalCondition;
	}
}