Package com.gradle.maven.extension.api.cache

Interface MojoMetadataProvider.Context

Enclosing interface:

MojoMetadataProvider

public static interface MojoMetadataProvider.Context

Allows configuring the inputs and outputs of a Mojo.

Since:

1.15

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MojoMetadataProvider.Context.FileSet	Holds a set of files and directories and allows configuring the MojoMetadataProvider.Context.FileSet.NormalizationStrategy, MojoMetadataProvider.Context.FileSet.LineEndingHandling and MojoMetadataProvider.Context.FileSet.EmptyDirectoryHandling.
static interface	MojoMetadataProvider.Context.Inputs	The inputs of a goal determine its cache key.
static interface	MojoMetadataProvider.Context.LocalState	Configures local state.
static interface	MojoMetadataProvider.Context.Outputs	The outputs of a goal are packed into the cache entry and restored when they are loaded from the build cache.

Method Summary

Modifier and Type	Method	Description
MojoExecution	getMojoExecution()	The goal execution being analyzed.
MavenProject	getProject()	The project that the goal execution is part of.
MavenSession	getSession()	The session associated with the project.
Object	getUnderlyingObject()	The object underlying the current context.
MojoMetadataProvider.Context	inputs(Consumer<? super MojoMetadataProvider.Context.Inputs> action)	The inputs of a goal determine its cache key.
MojoMetadataProvider.Context	iterate(String propertyName, Consumer<? super MojoMetadataProvider.Context> action)	Creates nested contexts by looking for a property of type Iterable or Object[] with the given name in the current context and calling the given action on each item in the Iterable or Object[], if it exists.
MojoMetadataProvider.Context	localState(Consumer<? super MojoMetadataProvider.Context.LocalState> action)	Local state is deleted if the outputs of a goal are retrieved from the build cache.
MojoMetadataProvider.Context	nested(String propertyName, Consumer<? super MojoMetadataProvider.Context> action)	Creates a nested context by looking for a property with the given name on the current context and calling the given action on it if it exists.
MojoMetadataProvider.Context	outputs(Consumer<? super MojoMetadataProvider.Context.Outputs> action)	The outputs of a goal are packed into the cache entry.
MojoMetadataProvider.Context	skipIfTrue(String... propertyNames)	The goal execution will be skipped, if any of the given boolean properties is true.
MojoMetadataProvider.Context	skipIfTrue(List<String> propertyNames)	The goal execution will be skipped, if any of the given boolean properties is true.
void	withPlugin(String artifactId, Runnable action)	Executes a given action if the supplied artifactId matches Plugin.getArtifactId().

Method Details

getUnderlyingObject

Object getUnderlyingObject()

The object underlying the current context. The root context will return the Mojo instance, while contexts created by nested(String, Consumer) and iterate(String, Consumer) will return the nested property value.

Since:

1.15

getMojoExecution

MojoExecution getMojoExecution()

The goal execution being analyzed.

Since:

1.15

getProject

MavenProject getProject()

The project that the goal execution is part of.

Since:

1.15

getSession

MavenSession getSession()

The session associated with the project.

Since:

1.15

withPlugin

void withPlugin(String artifactId,
 Runnable action)

Executes a given action if the supplied artifactId matches Plugin.getArtifactId(). If two plugins have the same artifactId but different groupIds the action will be executed for both.

Parameters:

artifactId - the artifact id for which to execute the action

action - the action to be executed

Since:

1.15

skipIfTrue

MojoMetadataProvider.Context skipIfTrue(String... propertyNames)

The goal execution will be skipped, if any of the given boolean properties is true.

Parameters:

propertyNames - the names of the boolean properties to be checked

Since:

1.15

skipIfTrue

MojoMetadataProvider.Context skipIfTrue(List<String> propertyNames)

The goal execution will be skipped, if any of the given boolean properties is true.

Parameters:

propertyNames - the names of the boolean properties to be checked

Since:

1.15

inputs

MojoMetadataProvider.Context inputs(Consumer<? super MojoMetadataProvider.Context.Inputs> action)

The inputs of a goal determine its cache key.

Parameters:

action - to be executed on the supplied MojoMetadataProvider.Context.Inputs

Since:

1.15

See Also:

• for more details

outputs

MojoMetadataProvider.Context outputs(Consumer<? super MojoMetadataProvider.Context.Outputs> action)

The outputs of a goal are packed into the cache entry.

Parameters:

action - to be executed on the supplied MojoMetadataProvider.Context.Outputs

Since:

1.15

See Also:

• for more details

localState

MojoMetadataProvider.Context localState(Consumer<? super MojoMetadataProvider.Context.LocalState> action)

Local state is deleted if the outputs of a goal are retrieved from the build cache. A common example would be temporary files or incremental analysis data.

Parameters:

action - to be executed on the supplied MojoMetadataProvider.Context.LocalState

Since:

1.15

See Also:

• for more details

nested

MojoMetadataProvider.Context nested(String propertyName,
 Consumer<? super MojoMetadataProvider.Context> action)

Creates a nested context by looking for a property with the given name on the current context and calling the given action on it if it exists. All property names in the nested context will be prefixed with the given property name.

Parameters:

propertyName - the name of the property to look for on the current context

action - the action to be executed if the supplied propertyName is found on the current context

Since:

1.15

iterate

MojoMetadataProvider.Context iterate(String propertyName,
 Consumer<? super MojoMetadataProvider.Context> action)

Creates nested contexts by looking for a property of type Iterable or Object[] with the given name in the current context and calling the given action on each item in the Iterable or Object[], if it exists. All property names in the nested contexts will be prefixed with the given property name and the index of the item in the Iterable or Object[].

Parameters:

propertyName - the name of the property to look for on the current context

action - the action to be executed if the supplied propertyName is found on the current context

Since:

1.15