net.digitalid.utility.threading.Threading Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of utility-threading Show documentation
The newest version!
package net.digitalid.utility.threading;

import javax.annotation.Nonnull;

import net.digitalid.utility.annotations.method.Pure;
import net.digitalid.utility.configuration.Configuration;
import net.digitalid.utility.validation.annotations.type.Functional;
import net.digitalid.utility.validation.annotations.type.Stateless;

/**
 * This interfaces facilitates the handling of threads.
 */
@Stateless
@Functional
public interface Threading {
    
    /* -------------------------------------------------- Interface -------------------------------------------------- */
    
    /**
     * Runs the given runnable on the GUI thread immediately or at some unspecified time in the future.
     * If the current thread is the GUI thread, then the given runnable may be executed immediately.
     * Otherwise, the given runnable is posted to an event queue and the method returns immediately.
     * The runnables passed to this method are guaranteed to be run in the order they were passed.
     */
    @Pure
    public void executeOnGuiThread(@Nonnull Runnable runnable);
    
    /* -------------------------------------------------- Configuration -------------------------------------------------- */
    
    /**
     * Stores the threading implementation which has to be provided by another package.
     */
    public static final @Nonnull Configuration configuration = Configuration.withUnknownProvider();
    
    /* -------------------------------------------------- Static Access -------------------------------------------------- */
    
    /**
     * Runs the given runnable on the GUI thread immediately or at some unspecified time in the future.
     * If the current thread is the GUI thread, then the given runnable may be executed immediately.
     * Otherwise, the given runnable is posted to an event queue and the method returns immediately.
     * The runnables passed to this method are guaranteed to be run in the order they were passed.
     */
    @Pure
    public static void runOnGuiThread(@Nonnull Runnable runnable) {
        configuration.get().executeOnGuiThread(runnable);
    }
    
    /* -------------------------------------------------- Main Thread -------------------------------------------------- */
    
    /**
     * Stores the main thread.
     */
    public static final @Nonnull Thread MAIN = Thread.currentThread();
    
    /**
     * Returns whether the current thread is the main thread.
     */
    @Pure
    public static boolean isMainThread() {
        return Thread.currentThread() == MAIN;
    }
    
}