001/*
002 * JDrupes Builder
003 * Copyright (C) 2026 Michael N. Lipp
004 * 
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
017 */
018
019package org.jdrupes.builder.api;
020
021/// Implemented by resources that can be evaluated, but want to indicate
022/// that something went wrong. A typical example is a [TestResult].
023/// As a resource it can be evaluated even if tests failed. Nevertheless,
024/// it should be easily visible that something went wrong.
025///
026public interface FaultAware {
027
028    /// Checks if the resource is faulty.
029    ///
030    /// @return true, if is faulty
031    ///
032    boolean isFaulty();
033
034    /// Sets the faulty state.
035    ///
036    /// @return the fault aware
037    ///
038    FaultAware setFaulty();
039}