Package org.grails.cli.compiler

Class DependencyCustomizer

java.lang.Object

org.grails.cli.compiler.DependencyCustomizer

public class DependencyCustomizer
extends java.lang.Object

Customizer that allows dependencies to be added during compilation. Adding a dependency results in a @Grab annotation being added to the primary class is the module that's being customized.

This class provides a fluent API for conditionally adding dependencies. For example: dependencies.ifMissing("com.corp.SomeClass").add(module).

Since:

2022.1.0

Constructor Summary

Constructors

Modifier	Constructor	Description
	DependencyCustomizer(groovy.lang.GroovyClassLoader loader, org.codehaus.groovy.ast.ModuleNode moduleNode, DependencyResolutionContext dependencyResolutionContext)	Create a new DependencyCustomizer instance.
protected	DependencyCustomizer(DependencyCustomizer parent)	Create a new nested DependencyCustomizer.

Method Summary

Modifier and Type	Method	Description
DependencyCustomizer	add(java.lang.String... modules)	Add dependencies and all of their dependencies.
DependencyCustomizer	add(java.lang.String module, boolean transitive)	Add a single dependency and, optionally, all of its dependencies.
DependencyCustomizer	add(java.lang.String module, java.lang.String classifier, java.lang.String type, boolean transitive)	Add a single dependency with the specified classifier and type and, optionally, all of its dependencies.
protected boolean	canAdd()	Strategy called to test if dependencies can be added.
DependencyResolutionContext	getDependencyResolutionContext()	Returns the DependencyResolutionContext.
java.lang.String	getVersion(java.lang.String artifactId)
java.lang.String	getVersion(java.lang.String artifactId, java.lang.String defaultVersion)
DependencyCustomizer	ifAllMissingClasses(java.lang.String... classNames)	Create a nested DependencyCustomizer that only applies if all the specified class names are not on the class path.
DependencyCustomizer	ifAllResourcesPresent(java.lang.String... paths)	Create a nested DependencyCustomizer that only applies if the specified paths are on the class path.
DependencyCustomizer	ifAnyMissingClasses(java.lang.String... classNames)	Create a nested DependencyCustomizer that only applies if any of the specified class names are not on the class path.
DependencyCustomizer	ifAnyResourcesPresent(java.lang.String... paths)	Create a nested DependencyCustomizer that only applies at least one of the specified paths is on the class path.

Methods inherited from class java.lang.Object

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

Constructor Detail

DependencyCustomizer

public DependencyCustomizer(groovy.lang.GroovyClassLoader loader,
                            org.codehaus.groovy.ast.ModuleNode moduleNode,
                            DependencyResolutionContext dependencyResolutionContext)

Create a new DependencyCustomizer instance.

Parameters:

loader - the current classloader

moduleNode - the current module

dependencyResolutionContext - the context for dependency resolution

DependencyCustomizer

protected DependencyCustomizer(DependencyCustomizer parent)

Create a new nested DependencyCustomizer.

Parameters:

parent - the parent customizer

Method Detail

getVersion

public java.lang.String getVersion(java.lang.String artifactId)

getVersion

public java.lang.String getVersion(java.lang.String artifactId,
                                   java.lang.String defaultVersion)

ifAnyMissingClasses

public DependencyCustomizer ifAnyMissingClasses(java.lang.String... classNames)

Create a nested DependencyCustomizer that only applies if any of the specified class names are not on the class path.

Parameters:

classNames - the class names to test

Returns:

a nested DependencyCustomizer

ifAllMissingClasses

public DependencyCustomizer ifAllMissingClasses(java.lang.String... classNames)

Create a nested DependencyCustomizer that only applies if all the specified class names are not on the class path.

Parameters:

classNames - the class names to test

Returns:

a nested DependencyCustomizer

ifAllResourcesPresent

public DependencyCustomizer ifAllResourcesPresent(java.lang.String... paths)

Create a nested DependencyCustomizer that only applies if the specified paths are on the class path.

Parameters:

paths - the paths to test

Returns:

a nested DependencyCustomizer

ifAnyResourcesPresent

public DependencyCustomizer ifAnyResourcesPresent(java.lang.String... paths)

Create a nested DependencyCustomizer that only applies at least one of the specified paths is on the class path.

Parameters:

paths - the paths to test

Returns:

a nested DependencyCustomizer

add

public DependencyCustomizer add(java.lang.String... modules)

Add dependencies and all of their dependencies. The group ID and version of the dependencies are resolved from the modules using the customizer's ArtifactCoordinatesResolver.

Parameters:

modules - the module IDs

Returns:

this DependencyCustomizer for continued use

add

public DependencyCustomizer add(java.lang.String module,
                                boolean transitive)

Add a single dependency and, optionally, all of its dependencies. The group ID and version of the dependency are resolved from the module using the customizer's ArtifactCoordinatesResolver.

Parameters:

module - the module ID

transitive - true if the transitive dependencies should also be added, otherwise false

Returns:

this DependencyCustomizer for continued use

add

public DependencyCustomizer add(java.lang.String module,
                                java.lang.String classifier,
                                java.lang.String type,
                                boolean transitive)

Add a single dependency with the specified classifier and type and, optionally, all of its dependencies. The group ID and version of the dependency are resolved from the module by using the customizer's ArtifactCoordinatesResolver.

Parameters:

module - the module ID

classifier - the classifier, may be null

type - the type, may be null

transitive - true if the transitive dependencies should also be added, otherwise false

Returns:

this DependencyCustomizer for continued use

canAdd

protected boolean canAdd()

Strategy called to test if dependencies can be added. Subclasses override as required. Returns true by default.

Returns:

true if dependencies can be added, otherwise false

getDependencyResolutionContext

public DependencyResolutionContext getDependencyResolutionContext()

Returns the DependencyResolutionContext.

Returns:

the dependency resolution context