org.myire.quill.common

Class Projects

java.lang.Object

org.myire.quill.common.Projects

public final class Projects
extends java.lang.Object

Project related utility methods.

Method Summary

Modifier and Type	Method and Description
static org.gradle.api.internal.file.FileResolver	createBaseDirectoryFileResolver(org.gradle.api.Project pProject, java.lang.Object pBaseDirectory) Create a file resolver that resolves paths relative to a base directory.
static java.io.File	createReportDirectorySpec(org.gradle.api.Project pProject, java.lang.String pDirectoryItemName) Create a file specification for a file or directory within the project's main report directory.
static java.io.File	createTemporaryDirectorySpec(org.gradle.api.Project pProject, java.lang.String pDirectoryItemName) Create a file specification for a temporary directory.
static void	ensureParentExists(java.io.File pFile) Ensure the parent directory of a file specification exists.
static boolean	extractResource(java.lang.String pResource, java.io.File pFile) Extract a classpath resource to a file.
static <T> T	getConventionPlugin(org.gradle.api.Project pProject, java.lang.String pName, java.lang.Class<T> pPluginClass) Get a plugin from a project's convention.
static <T> T	getExtension(org.gradle.api.Project pProject, java.lang.String pName, java.lang.Class<T> pExtensionClass) Get an extension from a project.
static org.gradle.api.internal.file.FileResolver	getFileResolver(org.gradle.api.Project pProject) Get a project's file resolver.
static org.gradle.api.tasks.SourceSet	getSourceSet(org.gradle.api.Project pProject, java.lang.String pName) Get a source set from a project.
static org.gradle.api.tasks.SourceSetContainer	getSourceSets(org.gradle.api.Project pProject) Get a project's SourceSetContainer.
static <T extends org.gradle.api.Task> T	getTask(org.gradle.api.Project pProject, java.lang.String pName, java.lang.Class<T> pTaskClass) Get a task from a project.

Methods inherited from class java.lang.Object

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

Method Detail

getSourceSets

public static org.gradle.api.tasks.SourceSetContainer getSourceSets(org.gradle.api.Project pProject)

Get a project's SourceSetContainer.

Parameters:

pProject - The project.

Returns:

The project's source set container, or null if the project has no source set container.

Throws:

java.lang.NullPointerException - if pProject is null.

getSourceSet

public static org.gradle.api.tasks.SourceSet getSourceSet(org.gradle.api.Project pProject,
                                                          java.lang.String pName)

Get a source set from a project.

Parameters:

pProject - The project.

pName - The name of the source set.

Returns:

The source set with the specified name, or null if there is no source set with that name in the project (including if the project has no source sets at all).

Throws:

java.lang.NullPointerException - if pProject is null.

getTask

public static <T extends org.gradle.api.Task> T getTask(org.gradle.api.Project pProject,
                                                        java.lang.String pName,
                                                        java.lang.Class<T> pTaskClass)

Get a task from a project.

Type Parameters:

T - The task's type.

Parameters:

pProject - The project.

pName - The name of the task.

pTaskClass - The task's class (or a superclass of its class).

Returns:

The task with the specified name, or null if there is no task with that name in the project. Null is also returned if there is a task with the specified name whose class is not (a subtype of) the specified task class.

Throws:

java.lang.NullPointerException - if pProject or pTaskClass is null.

getExtension

public static <T> T getExtension(org.gradle.api.Project pProject,
                                 java.lang.String pName,
                                 java.lang.Class<T> pExtensionClass)

Get an extension from a project.

Type Parameters:

T - The extension's type.

Parameters:

pProject - The project.

pName - The name of the extension.

pExtensionClass - The extension's class (or a superclass of its class).

Returns:

The extension with the specified name, or null if there is no extension with that name in the project. Null is also returned if there is an extension with the specified name whose class is not (a subtype of) the specified extension class.

Throws:

java.lang.NullPointerException - if pProject or pExtensionClass is null.

getConventionPlugin

public static <T> T getConventionPlugin(org.gradle.api.Project pProject,
                                        java.lang.String pName,
                                        java.lang.Class<T> pPluginClass)

Get a plugin from a project's convention.

Type Parameters:

T - The plugin's type.

Parameters:

pProject - The project.

pName - The name of the plugin.

pPluginClass - The plugin's class (or a superclass of its class).

Returns:

The plugin with the specified name, or null if there is no plugin with that name in the project's convention. Null is also returned if there is a plugin with the specified name whose class is not (a subtype of) the specified plugin class.

Throws:

java.lang.NullPointerException - if pProject or pPluginClass is null.

createReportDirectorySpec

public static java.io.File createReportDirectorySpec(org.gradle.api.Project pProject,
                                                     java.lang.String pDirectoryItemName)

Create a file specification for a file or directory within the project's main report directory. If the specified project has the reporting extension installed, that extension's baseDir property is used as the main reporting directory, otherwise the project's build directory is used as the main reporting directory.

Parameters:

pProject - The project to create the report directory spec for.

pDirectoryItemName - If non-null, the name of the directory item (file or subdirectory) within the project's main report directory to create the file spec for. If null, the file spec for the main report directory will be returned.

Returns:

A file specification for the specified report directory and directory item.

Throws:

java.lang.NullPointerException - if pProject is null.

createTemporaryDirectorySpec

public static java.io.File createTemporaryDirectorySpec(org.gradle.api.Project pProject,
                                                        java.lang.String pDirectoryItemName)

Create a file specification for a temporary directory.

Parameters:

pProject - The project to create the temporary directory spec for.

pDirectoryItemName - If non-null, the name of the directory item (file or subdirectory) within the project's temporary directory to create the file spec for. If null, the file spec for the project's temporary directory itself will be returned.

Returns:

A file specification for the specified work directory.

Throws:

java.lang.NullPointerException - if pProject is null.

getFileResolver

public static org.gradle.api.internal.file.FileResolver getFileResolver(org.gradle.api.Project pProject)

Get a project's file resolver.

Parameters:

pProject - The project to get the file resolver from.

Returns:

The project's file resolver, or null if the project is not of a type known to have a file resolver.

createBaseDirectoryFileResolver

public static org.gradle.api.internal.file.FileResolver createBaseDirectoryFileResolver(org.gradle.api.Project pProject,
                                                                                        java.lang.Object pBaseDirectory)

Create a file resolver that resolves paths relative to a base directory.

Parameters:

pProject - The project to create the resolver with.

pBaseDirectory - The resolver's base directory, this path will be resolved relative to the specified project's project directory before the resolver is created.

Returns:

A new FileResolver, or null if one couldn't be created.

extractResource

public static boolean extractResource(java.lang.String pResource,
                                      java.io.File pFile)

Extract a classpath resource to a file. The resource will be accessed through the class loader of the Projects class.

Parameters:

pResource - The name of the resource.

pFile - The file to extract the resource to.

Returns:

True if the file was created and the resource extracted to it, false if the file already existed (in which case it is left unmodified).

ensureParentExists

public static void ensureParentExists(java.io.File pFile)

Ensure the parent directory of a file specification exists.

Parameters:

pFile - The file for which to ensure the parent exists.

Throws:

java.lang.NullPointerException - if pFile is null.