Class AbstractProject

java.lang.Object

org.jdrupes.builder.core.AbstractProvider

org.jdrupes.builder.core.AbstractProject

All Implemented Interfaces:

Project, ResourceProvider

Direct Known Subclasses:

BootstrapBuild, BootstrapRoot

public abstract class AbstractProject
extends AbstractProvider
implements Project

A default implementation of a Project.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AbstractProject.CommandBuilder	The Class CommandBuilder.

Nested classes/interfaces inherited from interface Project

Project.Properties

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractProject(NamedParameter<?>... params)	Base class constructor for all projects.

Method Summary

Modifier and Type	Method	Description
RootProject.CommandBuilder	commandAlias(String name)	Define command, see RootProject.commandAlias(String).
Project	dependency(Intent intent, ResourceProvider provider)	Dependency.
Path	directory()	Directory.
protected static NamedParameter<Path>	directory(Path directory)	Named parameter for specifying the directory.
protected <T extends Resource> Stream<T>	doProvide(ResourceRequest<T> request)	Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.
boolean	equals(Object obj)
Project	generator(Generator provider)	Generator.
<T> T	get(PropertyKey property)	Returns the.
int	hashCode()
protected static NamedParameter<Path>	jdbldDirectory()	Hack to pass context().jdbldDirectory() as named parameter for the directory to the constructor.
String	name()	Returns the name of this resource provider.
protected static NamedParameter<String>	name(String name)	Named parameter for specifying the name.
<T extends Resource> T	newResource(ResourceType<T> type, Object... args)	Convenience function to create a new resource.
protected static NamedParameter<Class<? extends Project>>	parent(Class<? extends Project> parentProject)	Named parameter for specifying the parent project.
Optional<Project>	parentProject()	Parent project.
Project	project(Class<? extends Project> prjCls)	Project.
Stream<Project>	projects(String pattern)	Provide the projects matching the pattern.
DefaultProviderSelection	providers()	Providers.
ProviderSelection	providers(Set<Intent> intends)	Providers.
final RootProject	rootProject()	Root project.
AbstractProject	set(PropertyKey property, Object value)	Sets the.
String	toString()

Methods inherited from class AbstractProvider

context, of, rename, vavrStream

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Project

buildDirectory, dependency, generator, providers, readString, relativize

Methods inherited from interface ResourceProvider

context, of, of, resources

Constructor Details

AbstractProject

protected AbstractProject(NamedParameter<?>... params)

Base class constructor for all projects. The behavior depends on whether the project is a root project (implements RootProject) or a subproject and on whether the project specifies a parent project.

RootProjects must invoke this constructor with a null parent project class.

A sub project that wants to specify a parent project must invoke this constructor with the parent project's class. If a sub project does not specify a parent project, the root project is used as parent. In both cases, the constructor adds a Intent.Forward dependency between the parent project and the new project. This can then be overridden in the sub project's constructor.

Parameters:

params -

the named parameters

• parent - the class of the parent project

• name - the name of the project. If not provided the name is set to the (simple) class name

• directory - the directory of the project. If not provided, the directory is set to the name with uppercase letters converted to lowercase for subprojects.

  If a project implements MergedTestProject and does not specify a directory, its directory is set to the parent project's directory.

  For root projects the directory is always set to the current working directory.

Method Details

parent

protected static NamedParameter<Class<? extends Project>> parent(Class<? extends Project> parentProject)

Named parameter for specifying the parent project.

Parameters:

parentProject - the parent project

Returns:

the named parameter

name

protected static NamedParameter<String> name(String name)

Named parameter for specifying the name.

Parameters:

name - the name

Returns:

the named parameter

directory

protected static NamedParameter<Path> directory(Path directory)

Named parameter for specifying the directory.

Parameters:

directory - the directory

Returns:

the named parameter

jdbldDirectory

protected static NamedParameter<Path> jdbldDirectory()

Hack to pass context().jdbldDirectory() as named parameter for the directory to the constructor. This is required because you cannot "refer to an instance method while explicitly invoking a constructor".

Returns:

the named parameter

rootProject

public final RootProject rootProject()

Root project.

Specified by:

rootProject in interface Project

Returns:

the root project

project

public Project project(Class<? extends Project> prjCls)

Project.

Specified by:

project in interface Project

Parameters:

prjCls - the prj cls

Returns:

the project

parentProject

public Optional<Project> parentProject()

Parent project.

Specified by:

parentProject in interface Project

Returns:

the optional

name

public String name()

Description copied from interface: ResourceProvider

Returns the name of this resource provider.

Specified by:

name in interface ResourceProvider

Overrides:

name in class AbstractProvider

Returns:

the string

directory

public Path directory()

Directory.

Specified by:

directory in interface Project

Returns:

the path

generator

public Project generator(Generator provider)

Generator.

Specified by:

generator in interface Project

Parameters:

provider - the provider

Returns:

the project

dependency

public Project dependency(Intent intent,
 ResourceProvider provider)

Dependency.

Specified by:

dependency in interface Project

Parameters:

intent - the intent

provider - the provider

Returns:

the project

See Also:

• Project.generator(org.jdrupes.builder.api.Generator)
• Project.<T>generator(java.util.function.Function<org.jdrupes.builder.api.Project,T>)

providers

public DefaultProviderSelection providers()

Providers.

Specified by:

providers in interface Project

Returns:

the default provider selection

providers

public ProviderSelection providers(Set<Intent> intends)

Providers.

Specified by:

providers in interface Project

Parameters:

intends - the intends

Returns:

the provider selection

get

public <T> T get(PropertyKey property)

Returns the.

Specified by:

get in interface Project

Type Parameters:

T - the generic type

Parameters:

property - the property

Returns:

the t

set

public AbstractProject set(PropertyKey property,
 Object value)

Sets the.

Specified by:

set in interface Project

Parameters:

property - the property

value - the value

Returns:

the abstract project

doProvide

protected <T extends Resource> Stream<T> doProvide(ResourceRequest<T> request)

Description copied from class: AbstractProvider

Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.

Specified by:

doProvide in class AbstractProvider

Type Parameters:

T - the generic type

Parameters:

request - the requested

Returns:

the stream

newResource

public <T extends Resource> T newResource(ResourceType<T> type,
 Object... args)

Description copied from class: AbstractProvider

Convenience function to create a new resource. Short for invoking ResourceFactory.create(ResourceType, Project, Object...) with the requested resource type, null for the project and the remaining given arguments appended.

Specified by:

newResource in interface Project

Overrides:

newResource in class AbstractProvider

Type Parameters:

T - the resource type

Parameters:

type - the type

args - the arguments

Returns:

the resource

commandAlias

public RootProject.CommandBuilder commandAlias(String name)

Define command, see RootProject.commandAlias(String).

Parameters:

name - the name

Returns:

the root project

projects

public Stream<Project> projects(String pattern)

Provide the projects matching the pattern.

Parameters:

pattern - the pattern

Returns:

the stream

See Also:

• RootProject.projects(String)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class AbstractProvider