com.github.themrmilchmann.mjl.events.util.concurrent.MJLExecutors Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mjl-events Show documentation

A minimal Java library which provides an efficient and modular EventBus solution.

There is a newer version: 3.1.0

/*
 * Copyright 2018 Leon Linhart
 *
 * 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
 *
 *     http://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 com.github.themrmilchmann.mjl.events.util.concurrent;

import java.util.concurrent.Executor;

/**
 * A collection of executors that are commonly used with an EventBus.
 *
 * @since   1.0.0
 *
 * @author  Leon Linhart
 */
public final class MJLExecutors {

    private MJLExecutors() {}

    /**
     * Returns an {@link Executor} that runs each task directly in the thread that invokes
     * {@link Executor#execute(Runnable)}.
     *
     * The implementation is equivalent to:
     *
     * {@code
     * class DirectExecutor implements Executor {
     *
     *     public void execute(Runnable task) {
     *         task.run();
     *     }
     *
     * }
     * }
     *
     * @return  an {@link Executor} that runs each task directly in the thread that invokes
     *          {@link Executor#execute(Runnable)}
     *
     * @since   1.0.0
     */
    public static Executor directExecutor() {
        return DirectExecutor.INSTANCE;
    }

    private static final class DirectExecutor implements Executor {

        private static final Executor INSTANCE = new DirectExecutor();

        @Override
        public void execute(Runnable command) {
            command.run();
        }

    }

}