org.myire.quill.dependency

Class ModuleDependencySpec

java.lang.Object

org.myire.quill.dependency.DependencySpec

org.myire.quill.dependency.ModuleDependencySpec

All Implemented Interfaces:

PrettyPrintable

public class ModuleDependencySpec
extends DependencySpec

Specification of a dependency on an external module.

Constructor Summary

Constructors

Constructor and Description
ModuleDependencySpec(java.lang.String pConfiguration, java.lang.String pGroup, java.lang.String pName, java.lang.String pVersion) Create a new ModuleDependencySpec.

Method Summary

Modifier and Type	Method and Description
boolean	addTo(org.gradle.api.Project pProject) Add this dependency to a project.
java.lang.String	getClassifier()
java.lang.String	getExtension()
java.lang.String	getGroup()
java.lang.String	getName()
java.lang.String	getVersion()
protected boolean	hasNonDefaultAttribute() Check if this dependency has at least one attribute with a non-default value.
boolean	isChanging()
boolean	isForce()
void	prettyPrint(GradlePrettyPrinter pPrinter) Pretty print this instance with a GradlePrettyPrinter on a format suitable for build scripts.
protected void	printClosureBody(GradlePrettyPrinter pPrinter) Pretty print the body of a closure that sets the values of the dependency's non-default attributes.
void	setChanging(boolean pChanging)
void	setClassifier(java.lang.String pClassifier)
void	setExtension(java.lang.String pExtension)
void	setForce(boolean pForce)
java.lang.String	toDependencyNotation() Get the string notation for this dependency.

Methods inherited from class org.myire.quill.dependency.DependencySpec

addArtifact, addArtifact, addExclusion, addExclusion, forEachArtifact, forEachExclusion, getConfiguration, getNumArtifacts, getNumExclusions, isTransitive, prettyPrintDependencies, setConfiguration, setTransitive, setValues

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

quote

Constructor Detail

ModuleDependencySpec

public ModuleDependencySpec(java.lang.String pConfiguration,
                            java.lang.String pGroup,
                            java.lang.String pName,
                            java.lang.String pVersion)

Create a new ModuleDependencySpec.

Parameters:

pConfiguration - The name of the dependency's configuration.

pGroup - The dependency's group.

pName - The dependency's name.

pVersion - The dependency's version.

Throws:

java.lang.NullPointerException - if pConfiguration or pName is null.

Method Detail

getGroup

public java.lang.String getGroup()

getName

public java.lang.String getName()

getVersion

public java.lang.String getVersion()

getClassifier

public java.lang.String getClassifier()

setClassifier

public void setClassifier(java.lang.String pClassifier)

getExtension

public java.lang.String getExtension()

setExtension

public void setExtension(java.lang.String pExtension)

isChanging

public boolean isChanging()

setChanging

public void setChanging(boolean pChanging)

isForce

public boolean isForce()

setForce

public void setForce(boolean pForce)

toDependencyNotation

public java.lang.String toDependencyNotation()

Get the string notation for this dependency.

Specified by:

toDependencyNotation in class DependencySpec

Returns:

A string on the format "group:name:version:classifier@extension".

addTo

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

Description copied from class: DependencySpec

Add this dependency to a project.

Specified by:

addTo in class DependencySpec

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.

prettyPrint

public void prettyPrint(GradlePrettyPrinter pPrinter)

Description copied from interface: PrettyPrintable

Pretty print this instance with a GradlePrettyPrinter on a format suitable for build scripts.

Parameters:

pPrinter - The printer to print with.

hasNonDefaultAttribute

protected boolean hasNonDefaultAttribute()

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

Overrides:

hasNonDefaultAttribute in class DependencySpec

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.

Overrides:

printClosureBody in class DependencySpec

Parameters:

pPrinter - The printer to print with.

Throws:

java.lang.NullPointerException - if pPrinter is null.