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 * The running state is a property of a running service such as a thread and is closely related to
028 * {@link Thread.State}.
029 */
030@FunctionalInterface
031public interface ThreadState {
032
033    /**
034     * Returns the state of the underlying thread.
035     *
036     * @return the underlying thread's state
037     * @see Thread#getState()
038     */
039    Thread.State threadState();
040
041    /**
042     * Returns true if the underlying thread has been started but has not yet terminated.
043     *
044     * @return  true if {@link #threadState() thread state} is neither {@link Thread.State#NEW NEW} nor
045     *          {@link Thread.State#TERMINATED TERMINATED}
046     */
047    default boolean isRunning() {
048        final Thread.State state = threadState();
049        return state != Thread.State.NEW & state != Thread.State.TERMINATED;
050    }
051
052    /**
053     * Returns true if the underlying thread has terminated.
054     *
055     * @return  true if {@link #threadState() thread state} is {@link Thread.State#TERMINATED TERMINATED}
056     */
057    default boolean isTerminated() {
058        return threadState() == Thread.State.TERMINATED;
059    }
060}