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/// All [ResourceProvider]s have a name, but not all allow the name
022/// to be changed after creation. [ResourceProvider]s that allow
023/// renaming should implement this interface.
024/// 
025/// Make sure to redefine the return type of [#name] to the type
026/// of the implementing class. Else the method cannot be used
027/// in the fluent API.
028///
029@SuppressWarnings("PMD.ImplicitFunctionalInterface")
030public interface Renamable {
031
032    /// Set the new name.
033    ///
034    /// @param name the name
035    /// @return the renamable
036    ///
037    Renamable name(String name);
038
039}