001/**
002 * The MIT License (MIT)
003 *
004 * Copyright (c) 2019 nobark (tools4j), Marco Terzer, Anton Anufriev
005 *
006 * Permission is hereby granted, free of charge, to any person obtaining a copy
007 * of this software and associated documentation files (the "Software"), to deal
008 * in the Software without restriction, including without limitation the rights
009 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
010 * copies of the Software, and to permit persons to whom the Software is
011 * furnished to do so, subject to the following conditions:
012 *
013 * The above copyright notice and this permission notice shall be included in all
014 * copies or substantial portions of the Software.
015 *
016 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
017 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
018 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
019 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
020 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
021 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
022 * SOFTWARE.
023 */
024package org.tools4j.nobark.run;
025
026/**
027 * Joinable is a running service such as a thread that can be {@link #join() joined} to await
028 * its termination.
029 */
030@FunctionalInterface
031public interface Joinable {
032    /**
033     * Waits for this Joinable to die.
034     *
035     * <p> An invocation of this method behaves in exactly the same
036     * way as the invocation
037     *
038     * <blockquote>
039     * {@linkplain #join(long) join}{@code (0)}
040     * </blockquote>
041     *
042     * @throws  IllegalStateException
043     *          if any thread has interrupted the current thread
044     * @see Thread#join()
045     */
046    default void join() {
047        join(0);
048    }
049
050    /**
051     * Waits at most {@code millis} milliseconds for this Joinable to
052     * die. A timeout of {@code 0} means to wait forever.
053     *
054     * @param  millis
055     *         the time to wait in milliseconds
056     * @throws  IllegalArgumentException
057     *          if the value of {@code millis} is negative
058     * @throws  IllegalStateException
059     *          if any thread has interrupted the current thread
060     * @see Thread#join(long)
061     */
062    void join(long millis);
063}