org.nuiton.jaxx.runtime.application.action.ActionWorker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaxx-runtime Show documentation
JAXX Runtime api
The newest version!
/*
 * #%L
 * JAXX :: Runtime
 * %%
 * Copyright (C) 2008 - 2024 Code Lutin, Ultreia.io
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 *
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */
package org.nuiton.jaxx.runtime.application.action;

import io.ultreia.java4all.lang.Strings;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.LogManager;

import javax.swing.SwingWorker;
import java.util.Objects;
import java.util.concurrent.Callable;

/**
 * Action worker to execute a incoming action.
 *
 * @author Tony Chemit - [email protected]
 * @since 2.1
 */
public class ActionWorker extends SwingWorker {

    /** Logger */
    private static final Logger log = LogManager.getLogger(ActionWorker.class);

    protected final String actionLabel;

    protected Callable target;

    protected ActionStatus status;

    protected Exception error;

    protected long startTime;

    protected long endTime;

    public ActionWorker(String actionLabel) {
        this.actionLabel = actionLabel;
    }

    public ActionWorker(String actionLabel, Runnable target) {
        this.target = new RunnableBridge<>(target);
        this.actionLabel = actionLabel;
    }

    public Callable getTarget() {
        return target;
    }

    /**
     * Set the target to execute.
     *
     * @param target the target to execute
     * @since 2.5.1
     */
    public void setTarget(Callable target) {
        this.target = target;
    }

    public void setTarget(Runnable target) {
        setTarget(new RunnableBridge<>(target));
    }

    @Override
    protected R doInBackground() {
        Objects.requireNonNull(target, "Target field can not be null here.");
        startTime = System.nanoTime();
        log.debug("Action [" + getActionLabel() + "] is starting...");
        R result = null;
        try {

            result = getTarget().call();
        } catch (Exception e) {
            error = e;
        } finally {
            log.debug("Action [" + getActionLabel() + "] is ending...");
        }
        return result;
    }

    public boolean isFailed() {
        return (isDone() || isCancelled()) && error != null;
    }

    public Exception getError() {
        return error;
    }

    public ActionStatus getStatus() {
        return status;
    }

    public String getActionLabel() {
        return actionLabel;
    }

    @Override
    protected void done() {
        super.done();
        endTime = System.nanoTime();
        if (error != null) {
            status = ActionStatus.FAIL;
        } else if (isCancelled()) {
            status = ActionStatus.CANCEL;
        } else {
            status = ActionStatus.OK;
        }
        if (log.isDebugEnabled()) {
            log.debug("Action [" + getActionLabel() + "] ends with status : " + status + " in " + getTime());
        }
    }

    public String getTime() {
        return Strings.convertTime(endTime - startTime);
    }

    public long getStartTime() {
        return startTime;
    }

    public long getEndTime() {
        return endTime;
    }

    /** State of a running action */
    public enum ActionStatus {
        OK,
        CANCEL,
        FAIL
    }

    /**
     * Transform a {@link Runnable} into a {@link Callable}.
     *
     * @param  type of return (used to maintain generic checks in this class).
     * @since 2.5.1
     */
    private static class RunnableBridge implements Callable {

        private final Runnable target;

        public RunnableBridge(Runnable target) {
            this.target = target;
        }

        @Override
        public R call() {
            target.run();
            return null;
        }
    }

}