All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jboss.hal.flow.FlowContext Maven / Gradle / Ivy

Go to download

Async Flow based on Promise API

The newest version!
/*
 *  Copyright 2022 Red Hat
 *
 *  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
 *
 *      https://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.jboss.hal.flow;

import java.util.EmptyStackException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.Stack;
import java.util.function.Predicate;

import elemental2.promise.Promise;

/**
 * General purpose context to be used as a common data structure when executing a list of {@linkplain Task asynchronous tasks}
 * in {@linkplain Flow#parallel(FlowContext, List) parallel}, in {@linkplain Flow#sequential(FlowContext, List) sequence} or
 * when executing a task {@linkplain Flow#repeat(FlowContext, Task) repeatedly} while a {@linkplain Predicate condition}
 * evaluates to {@code true}.
 * 

 * The context provides a {@linkplain Progress progress indicator} to signal the progress of the task execution and a stack and
 * a map for sharing data between {@linkplain Task asynchronous tasks}.
 * 

 * Finally, the context provides methods to resolve the context as promise.
 */
public class FlowContext {

    /**
     * Method to check if the error in a {@linkplain Promise.CatchOnRejectedCallbackFn catch} callback is due to a timeout.
     */
    public static boolean timeout(Object error) {
        return error.equals(FlowRunner.TIMEOUT_ERROR);
    }

    private final Stack stack;
    private final Map data;
    final Progress progress;
    FlowStatus status;
    String failure;

    /**
     * Creates a new instance with a {@linkplain Progress#NOOP noop progress implementation}.
     */
    public FlowContext() {
        this(Progress.NOOP);
    }

    /**
     * Creates a new instance using the given progress indicator.
     *
     * @param progress the progress indicator to signal progress when executing the tasks
     */
    public FlowContext(Progress progress) {
        this.progress = progress;
        this.stack = new Stack<>();
        this.data = new HashMap<>();
        this.status = FlowStatus.NOT_STARTED;
    }

    // ------------------------------------------------------ control

    /**
     * Resolves this context successfully as a promise.
     */
    public  Promise resolve() {
        return resolveInternal();
    }

    /**
     * Pushes the value on top of the stack and resolves this context successfully as a promise.
     */
    public  Promise resolve(T value) {
        push(value);
        return resolveInternal();
    }

    /**
     * Stores the value under the given key in the map and resolves this context successfully as a promise.
     */
    public  Promise resolve(String key, T value) {
        set(key, value);
        return resolveInternal();
    }

    /**
     * Rejects this context with an error.
     */
    public  Promise reject(Object error) {
        return rejectInternal(error);
    }

    @SuppressWarnings("unchecked")
    private  Promise resolveInternal() {
        return (Promise) Promise.resolve(this);
    }

    private  Promise rejectInternal(Object error) {
        return Promise.reject(error);
    }

    // ------------------------------------------------------ data

    /**
     * Pushes the value om top of the stack.
     */
    public  void push(T value) {
        stack.push(value);
    }

    /**
     * Removes the object at the top of the stack and returns that object.
     *
     * @return The object at the top of the stack.
     * @throws EmptyStackException if this stack is empty.
     */
    @SuppressWarnings("unchecked")
    public  T pop() {
        return (T) stack.pop();
    }

    /**
     * Removes the object at the top of the stack and returns that object or returns the default value, if the stack is empty.
     *
     * @return The object at the top of the stack or the default value if the stack is empty.
     */
    @SuppressWarnings("unchecked")
    public  T pop(T defaultValue) {
        return emptyStack() ? defaultValue : (T) stack.pop();
    }

    /**
     * Returns the object at the top of the stack and keeps it on the stack.
     *
     * @return The object at the top of the stack.
     * @throws EmptyStackException if this stack is empty.
     */
    @SuppressWarnings("unchecked")
    public  T peek() {
        return (T) stack.peek();
    }

    /**
     * @return {@code true} if the stack is empty, {@code false} otherwise.
     */
    public boolean emptyStack() {
        return stack.empty();
    }

    /**
     * Stores the value under the given key in the map.
     */
    public  void set(String key, T value) {
        data.put(key, value);
    }

    /**
     * @return the object for the given key from the map or {@code null} if no such key was found.
     */
    public  T get(String key) {
        return get(key, null);
    }

    /**
     * @return the object for the given key from the context map or {@code defaultValue} if no such key was found.
     */
    @SuppressWarnings("unchecked")
    public  T get(String key, T defaultValue) {
        return (T) data.getOrDefault(key, defaultValue);
    }

    /**
     * @return the set of keys stored in the map.
     */
    public Set keys() {
        return data.keySet();
    }

    // ------------------------------------------------------ info

    /**
     * @return the execution status of this context
     */
    public FlowStatus status() {
        return status;
    }

    /**
     * @return whether the execution was successful
     */
    public boolean successful() {
        return status == FlowStatus.SUCCESS;
    }

    /**
     * @return whether the execution ran into a timeout
     */
    public boolean timeout() {
        return status == FlowStatus.TIMEOUT;
    }

    /**
     * @return whether the execution failed
     */
    public boolean failure() {
        return status == FlowStatus.FAILURE;
    }

    /**
     * @return the failure or {@code null} if the execution was successful or ran into a timeout
     */
    public String failureReason() {
        return failure;
    }

    @Override
    public String toString() {
        StringBuilder builder = new StringBuilder().append("FlowContext {");
        builder.append("stack: ").append(stack)
                .append(", map: ").append(data)
                .append(", status: ").append(status);
        if (status == FlowStatus.FAILURE && failure != null) {
            builder.append('(').append(failure).append(')');
        }
        return builder.append('}').toString();
    }
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy