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 functional interface whose
027 *  {@link #evaluate()}
028 *  method return a {@code boolean} and can throw an
029 *  {@link Exception}
030 *  in case of an error}.</p>
031 *
032 *  @version $Id: Constraint.java 1097 2024-02-06 20:10:12Z tquadrat $
033 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
034 *  @UMLGraph.link
035 *  @since 0.4.1
036 */
037@SuppressWarnings( "ProhibitedExceptionDeclared" )
038@FunctionalInterface
039@ClassVersion( sourceVersion = "$Id: Constraint.java 1097 2024-02-06 20:10:12Z tquadrat $" )
040@API( status = STABLE, since = "0.4.1" )
041public interface Constraint
042{
043        /*---------*\
044    ====** Methods **==========================================================
045        \*---------*/
046    /**
047     *  The operation.
048     *
049     *  @return The operation's result.
050     *
051     * @throws Exception Something went wrong.
052     */
053    @SuppressWarnings( "BooleanMethodNameMustStartWithQuestion" )
054    public boolean evaluate() throws Exception;
055}
056//  interface Constraint
057
058/*
059 *  End of File
060 */