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 marker interface to identify the root project.
022///
023public interface RootProject extends Project {
024
025    /// May be overridden by the root project to apply common settings
026    /// to projects of specific types or with specific properties.
027    /// 
028    /// This method must be invoked by any base class for project 
029    /// configuration classes before it returns the control to the
030    /// project configuration class' constructor. The method is never
031    /// invoked by the user.
032    ///
033    /// @param project the project to prepare
034    /// @throws Exception the exception
035    ///
036    @SuppressWarnings("PMD.SignatureDeclareThrowsException")
037    default void prepareProject(Project project) throws Exception {
038        // Default does nothing
039    }
040
041    /// Define an alias for requesting one more more specific resources.
042    ///
043    /// @param name the name
044    /// @param requests the requests
045    /// @return the root project
046    ///
047    default RootProject commandAlias(String name,
048            ResourceRequest<?>... requests) {
049        throw new UnsupportedOperationException();
050    }
051}