org.springframework.boot.cli.compiler

Class DependencyCustomizer

java.lang.Object

org.springframework.boot.cli.compiler.DependencyCustomizer

public class DependencyCustomizer
extends Object

Customizer that allows dependencies to be added during compilation. Delegates to Groovy Grapes to actually resolve dependencies. This class provides a fluent API for conditionally adding dependencies. For example: dependencies.ifMissing("com.corp.SomeClass").add(group, module, version).

Author:

Phillip Webb

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DependencyCustomizer(DependencyCustomizer parent) Create a new nested DependencyCustomizer.
	DependencyCustomizer(groovy.lang.GroovyClassLoader loader) Create a new DependencyCustomizer instance.

Method Summary

Methods

Modifier and Type	Method and Description
DependencyCustomizer	add(Map<String,Object>... dependencies) Add a dependencies.
DependencyCustomizer	add(String group, String module, String version) Add a single dependencies.
DependencyCustomizer	add(String group, String module, String version, boolean transitive) Add a single dependencies.
protected boolean	canAdd() Strategy called to test if dependencies can be added.
protected boolean	contains(String group, String module)
String	getProperty(String key)
String	getProperty(String key, String defaultValue)
DependencyCustomizer	ifAllMissingClasses(String... classNames) Create a nested DependencyCustomizer that only applies if all of the specified class names are not on the class path.
DependencyCustomizer	ifAllResourcesPresent(String... paths) Create a nested DependencyCustomizer that only applies if the specified paths are on the class path.
DependencyCustomizer	ifAnyMissingClasses(String... classNames) Create a nested DependencyCustomizer that only applies if any of the specified class names are not on the class path.
DependencyCustomizer	ifAnyResourcesPresent(String... paths) Create a nested DependencyCustomizer that only applies at least one of the specified paths is on the class path.
DependencyCustomizer	ifNotAdded(String group, String module) Create a nested DependencyCustomizer that only applies the specified one was not yet added.

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)

Create a new DependencyCustomizer instance. The call() method must be used to actually resolve dependencies.

Parameters:

loader -

DependencyCustomizer

protected DependencyCustomizer(DependencyCustomizer parent)

Create a new nested DependencyCustomizer.

Parameters:

parent -

Method Detail

getProperty

public String getProperty(String key)

getProperty

public String getProperty(String key,
                 String defaultValue)

ifAnyMissingClasses

public DependencyCustomizer ifAnyMissingClasses(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(String... classNames)

Create a nested DependencyCustomizer that only applies if all of 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(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(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

ifNotAdded

public DependencyCustomizer ifNotAdded(String group,
                              String module)

Create a nested DependencyCustomizer that only applies the specified one was not yet added.

Returns:

a nested DependencyCustomizer

contains

protected boolean contains(String group,
               String module)

Parameters:

group - the group ID

module - the module ID

Returns:

true if this module is already in the dependencies

add

public DependencyCustomizer add(String group,
                       String module,
                       String version)

Add a single dependencies.

Parameters:

group - the group ID

module - the module ID

version - the version

Returns:

this DependencyCustomizer for continued use

add

public DependencyCustomizer add(String group,
                       String module,
                       String version,
                       boolean transitive)

Add a single dependencies.

Parameters:

group - the group ID

module - the module ID

version - the version

Returns:

this DependencyCustomizer for continued use

add

public DependencyCustomizer add(Map<String,Object>... dependencies)

Add a dependencies.

Parameters:

dependencies - a map of the dependencies to add.

Returns:

this DependencyCustomizer for continued use

canAdd

protected boolean canAdd()

Strategy called to test if dependencies can be added. Subclasses override as required.