001/*
002 * ============================================================================
003 *  Copyright © 2002-2021 by Thomas Thrien.
004 *  All Rights Reserved.
005 * ============================================================================
006 *  Licensed to the public under the agreements of the GNU Lesser General Public
007 *  License, version 3.0 (the "License"). You may obtain a copy of the License at
008 *
009 *       http://www.gnu.org/licenses/lgpl.html
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, WITHOUT
013 *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
014 *  License for the specific language governing permissions and limitations
015 *  under the License.
016 */
017
018package org.tquadrat.foundation.lang;
019
020import static org.apiguardian.api.API.Status.STABLE;
021
022import org.apiguardian.api.API;
023import org.tquadrat.foundation.annotation.ClassVersion;
024
025/**
026 *  <p>{@summary A variant of the interface
027 *  {@link Runnable}
028 *  with a
029 *  {@link #run()}
030 *  method that allows to throw an exception.}</p>
031 *  <p>This is a functional interface whose functional method is
032 *  {@link #run()}.</p>
033 *
034 *  @version $Id: Action.java 982 2022-01-08 09:40:32Z tquadrat $
035 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
036 *  @UMLGraph.link
037 *  @since 0.1.0
038 */
039@SuppressWarnings( "ProhibitedExceptionDeclared" )
040@FunctionalInterface
041@ClassVersion( sourceVersion = "$Id: Action.java 982 2022-01-08 09:40:32Z tquadrat $" )
042@API( status = STABLE, since = "0.1.0" )
043public interface Action
044{
045        /*---------*\
046    ====** Methods **==========================================================
047        \*---------*/
048    /**
049     * The action.
050     *
051     * @throws Exception Something went wrong.
052     */
053    public abstract void run() throws Exception;
054}
055//  interface Action
056
057/*
058 *  End of File
059 */