org.myire.quill.dependency

Class DependencySpec

java.lang.Object

org.myire.quill.dependency.DependencySpec

All Implemented Interfaces:

PrettyPrintable

Direct Known Subclasses:

ModuleDependencySpec, ProjectDependencySpec

public abstract class DependencySpec
extends java.lang.Object
implements PrettyPrintable

Abstract base class for dependency specifications.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DependencySpec(java.lang.String pConfiguration) Create a new DependencySpec.

Method Summary

Modifier and Type	Method and Description
void	addArtifact(ArtifactSpec pArtifactSpec) Add an artifact specification to this dependency.
void	addArtifact(java.lang.String pName, java.lang.String pType, java.lang.String pExtension, java.lang.String pClassifier, java.lang.String pUrl) Add an artifact specification to this dependency.
void	addExclusion(ExclusionSpec pExclusionSpec) Add an exclusion specification to this dependency.
void	addExclusion(java.lang.String pGroup, java.lang.String pModule) Add an exclusion specification to this dependency.
abstract boolean	addTo(org.gradle.api.Project pProject) Add this dependency to a project.
void	forEachArtifact(java.util.function.Consumer<? super ArtifactSpec> pAction) Perform an action for each artifact specification.
void	forEachExclusion(java.util.function.Consumer<? super ExclusionSpec> pAction) Perform an action for each exclusion specification.
java.lang.String	getConfiguration()
int	getNumArtifacts() Get the number of artifact specifications added to this instance.
int	getNumExclusions() Get the number of exclusion specifications added to this instance.
protected boolean	hasNonDefaultAttribute() Check if this dependency has at least one attribute with a non-default value.
boolean	isTransitive()
static void	prettyPrintDependencies(GradlePrettyPrinter pPrinter, java.util.Collection<? extends DependencySpec> pDependencies) Pretty print a collection of dependency specifications.
protected void	printClosureBody(GradlePrettyPrinter pPrinter) Pretty print the body of a closure that sets the values of the dependency's non-default attributes.
void	setConfiguration(java.lang.String pConfiguration)
void	setTransitive(boolean pTransitive)
void	setValues(DependencySpec pValues) Set the values in this instance by copying them from another DependencySpec.
abstract java.lang.String	toDependencyNotation() Get the string notation for this dependency.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.myire.quill.common.PrettyPrintable

prettyPrint, quote

Constructor Detail

DependencySpec

protected DependencySpec(java.lang.String pConfiguration)

Create a new DependencySpec.

Parameters:

pConfiguration - The name of the dependency's configuration.

Throws:

java.lang.NullPointerException - if pConfiguration is null.

Method Detail

getConfiguration

public java.lang.String getConfiguration()

setConfiguration

public void setConfiguration(java.lang.String pConfiguration)

isTransitive

public boolean isTransitive()

setTransitive

public void setTransitive(boolean pTransitive)

getNumExclusions

public int getNumExclusions()

Get the number of exclusion specifications added to this instance.

Returns:

The number of exclusion specifications.

forEachExclusion

public void forEachExclusion(java.util.function.Consumer<? super ExclusionSpec> pAction)

Perform an action for each exclusion specification.

Parameters:

pAction - The action to apply to the exclusion specifications.

Throws:

java.lang.NullPointerException - if pAction is null.

addExclusion

public void addExclusion(ExclusionSpec pExclusionSpec)

Add an exclusion specification to this dependency.

Parameters:

pExclusionSpec - The specification to add.

addExclusion

public void addExclusion(java.lang.String pGroup,
                         java.lang.String pModule)

Add an exclusion specification to this dependency.

Parameters:

pGroup - The exclusion's group.

pModule - The exclusion's module.

getNumArtifacts

public int getNumArtifacts()

Get the number of artifact specifications added to this instance.

Returns:

The number of artifact specifications.

forEachArtifact

public void forEachArtifact(java.util.function.Consumer<? super ArtifactSpec> pAction)

Perform an action for each artifact specification.

Parameters:

pAction - The action to apply to the artifact specifications.

Throws:

java.lang.NullPointerException - if pAction is null.

addArtifact

public void addArtifact(ArtifactSpec pArtifactSpec)

Add an artifact specification to this dependency.

Parameters:

pArtifactSpec - The specification to add.

addArtifact

public void addArtifact(java.lang.String pName,
                        java.lang.String pType,
                        java.lang.String pExtension,
                        java.lang.String pClassifier,
                        java.lang.String pUrl)

Add an artifact specification to this dependency.

Parameters:

pName - The name of the artifact.

pType - The artifact's type. Normally the same value as the extension, e.g. "jar".

pExtension - The artifact's extension. Normally the same value as the type.

pClassifier - The artifact's classifier.

pUrl - The URL under which the artifact can be retrieved.

Throws:

java.lang.NullPointerException - if pName is null.

setValues

public void setValues(DependencySpec pValues)

Set the values in this instance by copying them from another DependencySpec.

Parameters:

pValues - The values to copy into this instance.

Throws:

java.lang.NullPointerException - if pValues is null.

toDependencyNotation

public abstract java.lang.String toDependencyNotation()

Get the string notation for this dependency.

Returns:

The dependency's string notation.

addTo

public abstract boolean addTo(org.gradle.api.Project pProject)

Add this dependency to a project.

Parameters:

pProject - The project to add this dependency to.

Returns:

True if the dependency was added, false if it's configuration doesn't exist in the project and it therefore wasn't added.

Throws:

java.lang.NullPointerException - if pProject is null.

prettyPrintDependencies

public static void prettyPrintDependencies(GradlePrettyPrinter pPrinter,
                                           java.util.Collection<? extends DependencySpec> pDependencies)

Pretty print a collection of dependency specifications.

Parameters:

pPrinter - The printer to print with.

pDependencies - The dependencies to print.

Throws:

java.lang.NullPointerException - if any of the parameters is null.

hasNonDefaultAttribute

protected boolean hasNonDefaultAttribute()

Check if this dependency has at least one attribute with a non-default value.

Returns:

True if at least one of the attributes has a non-default value, false if all attributes have default values.

printClosureBody

protected void printClosureBody(GradlePrettyPrinter pPrinter)

Pretty print the body of a closure that sets the values of the dependency's non-default attributes.

Parameters:

pPrinter - The printer to print with.

Throws:

java.lang.NullPointerException - if pPrinter is null.