org.myire.quill.dependency

Class ProjectDependencySpec

java.lang.Object

org.myire.quill.dependency.DependencySpec

org.myire.quill.dependency.ProjectDependencySpec

All Implemented Interfaces:

PrettyPrintable

public class ProjectDependencySpec
extends DependencySpec

Specification of a dependency on a Gradle project in the current build.

Constructor Summary

Constructors

Constructor and Description
ProjectDependencySpec(java.lang.String pConfiguration, java.lang.String pProjectPath) Create a new ProjectDependencySpec.

Method Summary

Modifier and Type	Method and Description
boolean	addTo(org.gradle.api.Project pProject) Add this dependency to a project.
java.lang.String	getProjectPath()
void	prettyPrint(GradlePrettyPrinter pPrinter) Pretty print this instance with a GradlePrettyPrinter on a format suitable for build scripts.
java.lang.String	toDependencyNotation() Get the string notation for this dependency.
java.util.Map<java.lang.String,java.lang.String>	toMap()

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

addArtifact, addArtifact, addExclusion, addExclusion, forEachArtifact, forEachExclusion, getConfiguration, getNumArtifacts, getNumExclusions, hasNonDefaultAttribute, isTransitive, prettyPrintDependencies, printClosureBody, 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

ProjectDependencySpec

public ProjectDependencySpec(java.lang.String pConfiguration,
                             java.lang.String pProjectPath)

Create a new ProjectDependencySpec.

Parameters:

pConfiguration - The name of the dependency's configuration.

pProjectPath - The path to the project.

Throws:

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

Method Detail

getProjectPath

public java.lang.String getProjectPath()

toMap

public java.util.Map<java.lang.String,java.lang.String> toMap()

toDependencyNotation

public java.lang.String toDependencyNotation()

Description copied from class: DependencySpec

Get the string notation for this dependency.

Specified by:

toDependencyNotation in class DependencySpec

Returns:

The dependency's string notation.

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.