001/*
002 * Trident - A Multithreaded Server Alternative
003 * Copyright 2014 The TridentSDK Team
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *    http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package net.tridentsdk.concurrent;
019
020import javax.annotation.concurrent.ThreadSafe;
021import java.util.concurrent.Callable;
022import java.util.concurrent.Future;
023
024/**
025 * Execution abstraction
026 *
027 * @author The TridentSDK Team
028 * @since 0.3-alpha-DP
029 */
030@ThreadSafe
031public interface SelectableThread {
032    /**
033     * Adds the task to the queue
034     *
035     * @param task the task to add
036     */
037    void execute(Runnable task);
038
039    /**
040     * Runs a callback which returns a value as a future
041     *
042     * @param task the callback to run
043     * @param <V> the return type of the callback
044     * @return the returned value
045     */
046    <V> Future<V> submitTask(Callable<V> task);
047
048    /**
049     * Closes the thread and stops execution of new / remaining tasks
050     */
051    void interrupt();
052
053    /**
054     * Thread form
055     *
056     * @return the thread that is running
057     */
058    Thread asThread();
059}