001/*
002 * JDrupes Builder
003 * Copyright (C) 2025 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/// A "phony resource" that (when requested) causes a generator to remove
022/// its generated outputs.
023/// 
024/// Note that requesting [Cleanliness] may leave [ResourceProvider]s in an
025/// inconsistent state. The reason is that providers can cache resources
026/// that they depend on. If a [Cleanliness] resource is requested, all
027/// cleaned resources would have to be removed from these caches, which
028/// cannot be done reliably.
029/// 
030/// Therefore, the build project should be discarded after [Cleanliness]
031/// has been requested and re-generated. 
032///
033public interface Cleanliness extends Resource {
034}