All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.requirementsascode.StepToBeRun Maven / Gradle / Ivy

    There is a newer version: 2.0
    Show newest version
    package org.requirementsascode;

import java.io.Serializable;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.function.Function;

/**
 * Use an instance of this class if you want to find out the details about the
 * step to be run in a custom message handler, and to trigger the system reaction.
 *
 * @see ModelRunner#handleWith(Consumer)
 * @author b_muth
 */
public class StepToBeRun implements Serializable {
	private static final long serialVersionUID = -8615677956101523359L;

	private Step step; 
	private Object message;
	private Consumer eventPublisher;

	StepToBeRun() {
	}

	/**
	 * Triggers the system reaction of this step, and publishes the resulting
	 * event.
	 */
	public void run() {
		Object eventToBePublished = runSystemReactionOfStep();
		if(eventToBePublished != null) {
			eventPublisher.accept(eventToBePublished);
		}
	}
	
	private Object runSystemReactionOfStep() {
		@SuppressWarnings("unchecked")
		Function systemReactionFunction = (Function) step.getSystemReaction();
		Object eventToBePublished = systemReactionFunction.apply(message);
		return eventToBePublished;
	}

	/**
	 * Returns the name of the step whose system reaction is performed when
	 * {@link #run()} is called.
	 *
	 * @return the step name.
	 */
	public String getStepName() {
		return step.getName();
	}

	/**
	 * Returns the precondition that needs to be true to trigger the system reaction
	 * when {@link #run()} is called.
	 *
	 * @return the condition, or an empty optional when no condition was specified.
	 */
	public Optional getCondition() {
		Optional optionalCondition = step.getCondition();
		return optionalCondition;
	}

	/**
	 * Returns the message object that will be passed to the system reaction when
	 * {@link #run()} is called.
	 *
	 * @return the message, or an empty optional when no message was specified.
	 */
	public Optional getMessage() {
		Optional optionalMessage = null;
		if (message instanceof ModelRunner) {
			optionalMessage = Optional.empty();
		} else {
			optionalMessage = Optional.of(message);
		}
		return optionalMessage;
	}

	/**
	 * Returns the system reaction to be executed when {@link #run()} is called.
	 *
	 * @return the system reaction object, as specified in the model.
	 */
	public Object getSystemReaction() {
		Object systemReactionObject = step.getSystemReaction().getModelObject();
		return systemReactionObject;
	}

	void setupWith(Step useCaseStep, Object message, Consumer eventPublisher) {
		this.step = useCaseStep;
		this.message = message;
		this.eventPublisher = eventPublisher;
	}
}
    
    
    
    

    




    
    
    © 2015 - 2024 Weber Informatics LLC | Privacy Policy