Class DefaultBuildContext

java.lang.Object

org.jdrupes.builder.core.DefaultBuildContext

All Implemented Interfaces:

AutoCloseable, BuildContext

public class DefaultBuildContext
extends Object
implements BuildContext

A context for building.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DefaultBuildContext.RequestChainLink	A link in the call chain.

Field Summary

Fields inherited from interface BuildContext

BUILD_EXTENSIONS, EXTENSIONS_SNAPSHOT_REPOSITORY, JDBLD_COMMON_DIRECTORY, JDBLD_DIRECTORY, JDBLD_VERSION

Method Summary

Modifier and Type	Method	Description
Path	buildRoot()	Returns the build root.
void	close()	Close the context.
org.apache.commons.cli.CommandLine	commandLine()	The command line as processed by Apache Commons CLI.
PrintStream	error()	Returns a PrintStream for errors.
AwaitableCounter	executingFutureStreams()	Executing future streams.
ExecutorService	executor()	Returns the executor service used by this build to create futures.
void	executor(ExecutorService executor)	Sets the executor service used by this build to create futures.
static boolean	isProviderInvocationAllowed()	Checks if is provider invocation is allowed.
PrintStream	out()	Returns the PrintStream for the standard output.
String	property(String name, String defaultValue)	Returns the value of the given property.
<T extends Resource> Stream<T>	resources(ResourceProvider provider, ResourceRequest<T> request)	Obtains the stream of resources of the given type from the given provider.
ScopedValue.Carrier	startRequestChain(ScopedValue.Carrier carriers)	Start request chain.
StatusLine	statusLine()	Returns the status line for the current thread.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface BuildContext

commonCacheDirectory, jdbldDirectory

Method Details

executor

public ExecutorService executor()

Returns the executor service used by this build to create futures.

Returns:

the executor service

executor

public void executor(ExecutorService executor)

Sets the executor service used by this build to create futures.

Parameters:

executor - the executor

executingFutureStreams

public AwaitableCounter executingFutureStreams()

Executing future streams.

Returns:

the awaitable counter

buildRoot

public Path buildRoot()

Returns the build root.

Returns:

the path

commandLine

public org.apache.commons.cli.CommandLine commandLine()

Description copied from interface: BuildContext

The command line as processed by Apache Commons CLI.

Specified by:

commandLine in interface BuildContext

Returns:

the parsed command line

property

public String property(String name,
 String defaultValue)

Description copied from interface: BuildContext

Returns the value of the given property. Properties are defined by (in order of precedence):

1. command line options
2. the file .jdbld.properties in the directory of the root project
3. the file .jdbld/jdbld.properties in the user's home directory

Specified by:

property in interface BuildContext

Parameters:

name - the name

defaultValue - the default value

Returns:

the string

startRequestChain

public ScopedValue.Carrier startRequestChain(ScopedValue.Carrier carriers)

Start request chain.

Parameters:

carriers - the carriers

Returns:

the scoped value. carrier

statusLine

public StatusLine statusLine()

Description copied from interface: BuildContext

Returns the status line for the current thread. The status line may be used by ResourceProviders to indicate progress during the execution of ResourceProviderSpi.provide(ResourceRequest). A StatusLine is automatically allocated by the context when BuildContext.resources(ResourceProvider, ResourceRequest) is invoked.

When called while not executing BuildContext.resources(ResourceProvider, ResourceRequest), this method returns a dummy status line that discards all updates.

Specified by:

statusLine in interface BuildContext

Returns:

the status line

out

public PrintStream out()

Description copied from interface: BuildContext

Returns the PrintStream for the standard output.

Specified by:

out in interface BuildContext

Returns:

the prints the stream

error

public PrintStream error()

Description copied from interface: BuildContext

Returns a PrintStream for errors. The data is sent to the standard output stream as with BuildContext.out(), but it is marked, typically in red, to indicate an error.

Specified by:

error in interface BuildContext

Returns:

the prints the stream

resources

public <T extends Resource> Stream<T> resources(ResourceProvider provider,
 ResourceRequest<T> request)

Description copied from interface: BuildContext

Obtains the stream of resources of the given type from the given provider. The result from invoking the provider is evaluated asynchronously and cached. Only when the returned stream is consumed will the invocation block until the result from the provider becomes available.

To avoid duplicate invocations of a non-project provider, any intends are removed from the request before such a provider is invoked.

Specified by:

resources in interface BuildContext

Type Parameters:

T - the resource type

Parameters:

provider - the provider

request - the request

Returns:

the results

isProviderInvocationAllowed

public static boolean isProviderInvocationAllowed()

Checks if is provider invocation is allowed. Clears the allowed flag to also detect nested invocations.

Returns:

true, if is provider invocation allowed

close

public void close()

Description copied from interface: BuildContext

Close the context. The re-declaration of this method removes the IOException, which is never thrown.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface BuildContext