com.prezi.pride

Class PrideConvention

java.lang.Object

com.prezi.pride.PrideConvention

public class PrideConvention
extends java.lang.Object

Adds a few useful methods to look up relative projects via project paths like ":sibling" or "::aunt". We need this because Gradle by default does not allow relative project references to parent projects, only children. Created by lptr on 02/04/14.

Constructor Summary

Constructors

Constructor and Description
PrideConvention(org.gradle.api.Project project)

Method Summary

Modifier and Type	Method and Description
org.gradle.api.Project	findRelativeProject(java.lang.String path) Locates a project by path.
org.gradle.api.artifacts.ProjectDependency	relativeProject(java.util.Map<java.lang.String,?> notation) Locates a project dependency by notation.
org.gradle.api.Project	relativeProject(java.lang.String path) Locates a project by path.
org.gradle.api.Project	relativeProject(java.lang.String path, groovy.lang.Closure<?> configureClosure) Locates a project by path and configures it using the given closure.
static java.util.Map<java.lang.String,?>	resolveProjectPath(org.gradle.api.Project project, java.util.Map<java.lang.String,?> notation)

Methods inherited from class java.lang.Object

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

Constructor Detail

PrideConvention

public PrideConvention(org.gradle.api.Project project)

Method Detail

resolveProjectPath

public static java.util.Map<java.lang.String,?> resolveProjectPath(org.gradle.api.Project project,
                                                                   java.util.Map<java.lang.String,?> notation)

findRelativeProject

public org.gradle.api.Project findRelativeProject(java.lang.String path)

Locates a project by path. If the path is relative, it is interpreted relative to this project.

Parameters:

path - The path.

Returns:

The project with the given path. Returns null if no such project exists.

relativeProject

public org.gradle.api.Project relativeProject(java.lang.String path)
                                       throws org.gradle.api.UnknownProjectException

Locates a project by path. If the path is relative, it is interpreted relative to this project.

Parameters:

path - The path.

Returns:

The project with the given path. Never returns null.

Throws:

org.gradle.api.UnknownProjectException - If no project with the given path exists.

relativeProject

public org.gradle.api.artifacts.ProjectDependency relativeProject(java.util.Map<java.lang.String,?> notation)

Locates a project dependency by notation. If the path is relative, it is interpreted relative to this project. This is to be used from the dependencies { ... } block.

Parameters:

notation - A map containing the parameters to create the projet.

Returns:

The project with the given path. Never returns null.

Throws:

org.gradle.api.UnknownProjectException - If no project with the given path exists.

relativeProject

public org.gradle.api.Project relativeProject(java.lang.String path,
                                              groovy.lang.Closure<?> configureClosure)
                                       throws org.gradle.api.UnknownProjectException

Locates a project by path and configures it using the given closure. If the path is relative, it is interpreted relative to this project. The target project is passed to the closure as the closure's delegate.

Parameters:

path - The path.

configureClosure - The closure to use to configure the project.

Returns:

The project with the given path. Never returns null.

Throws:

org.gradle.api.UnknownProjectException - If no project with the given path exists.