Interface RootProject

All Superinterfaces:

Project, ResourceProvider

All Known Implementing Classes:

BootstrapRoot

public interface RootProject
extends Project

A marker interface to identify the root project.

Nested Class Summary

Nested classes/interfaces inherited from interface Project

Project.Properties

Method Summary

Modifier and Type	Method	Description
default RootProject	commandAlias(String name, ResourceRequest<?>... requests)	Define an alias for requesting one more more specific resources.
default void	prepareProject(Project project)	May be overridden by the root project to apply common settings to projects of specific types or with specific properties.

Methods inherited from interface Project

buildDirectory, context, dependency, dependency, directory, from, from, from, generator, generator, get, get, name, newResource, project, provided, providers, providers, readString, relativize, rootProject, set

Methods inherited from interface ResourceProvider

provide

Method Details

prepareProject

default void prepareProject(Project project)
                     throws Exception

May be overridden by the root project to apply common settings to projects of specific types or with specific properties.

This method must be invoked by any base class for project configuration classes before it returns the control to the project configuration class' constructor. The method is never invoked by the user.

Parameters:

project - the project to prepare

Throws:

Exception - the exception

commandAlias

default RootProject commandAlias(String name,
 ResourceRequest<?>... requests)

Define an alias for requesting one more more specific resources.

Parameters:

name - the name

requests - the requests

Returns:

the root project