com.brambolt.gradle

Class ArchiveBuildPlugin

java.lang.Object

com.brambolt.gradle.ArchiveBuildPlugin

All Implemented Interfaces:

org.gradle.api.Plugin<org.gradle.api.Project>

public class ArchiveBuildPlugin
extends java.lang.Object
implements org.gradle.api.Plugin<org.gradle.api.Project>

Configures a Gradle build to build and publish an archive.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<java.lang.String>	PLUGIN_IDS The plugins to apply to the project.
static java.util.List<java.lang.String>	REQUIRED_PROPERTIES The project-specific properties that must be set.

Constructor Summary

Constructors

Constructor and Description
ArchiveBuildPlugin()

Method Summary

Modifier and Type	Method and Description
void	apply(org.gradle.api.Project project) Applies the plugin and configures the build.
static void	configureMainSourceSetResourcePaths(org.gradle.api.Project project, java.util.List<java.lang.String> srcDirsPaths) Sets the source directories for the main source set.
static void	configureMainSourceSetResourcePaths(org.gradle.api.Project project, java.lang.String... srcDirsPaths) Sets the source directories for the main source set.
static void	configurePluginInclusion(java.util.Map<java.lang.String,java.util.function.Predicate<org.gradle.api.Project>> pluginInclusion) Configures plugin inclusion.
static void	configureProcessResourcesTask(org.gradle.api.Project project, java.util.List<java.lang.String> taskDependencies) Configures the processResources task.
static void	configureProcessResourcesTask(org.gradle.api.Project project, java.util.Map<java.lang.String,java.lang.Object> replaceTokens) Configures the processResources task.
static void	configureProcessResourcesTask(org.gradle.api.Project project, java.util.Map<java.lang.String,java.lang.Object> replaceTokens, java.util.List<java.lang.String> taskDependencies) Configures the processResources task.
static void	configureProcessResourcesTask(org.gradle.api.Project project, java.lang.String... taskDependencies) Configures the processResources task.
static void	configureResourcePaths(org.gradle.api.Project project) Sets the main source set resource paths to the default values.
static void	configureResourcePaths(org.gradle.api.Project project, java.util.List<java.lang.String> resourcePaths) Sets the main source set resource paths.
static com.brambolt.gradle.velocity.tasks.Velocity	configureVelocityTask(org.gradle.api.Project project) Configures Velocity template instantiation.
static com.brambolt.gradle.velocity.tasks.Velocity	configureVelocityTask(org.gradle.api.Project project, java.util.Map<java.lang.String,java.lang.Object> context) Configures Velocity template instantiation.
static com.brambolt.gradle.velocity.tasks.Velocity	configureVelocityTask(org.gradle.api.Project project, java.util.Map<java.lang.String,java.lang.Object> context, java.util.List<java.lang.String> taskDependencies) Configures Velocity template instantiation.
static com.brambolt.gradle.velocity.tasks.Velocity	configureVelocityTask(org.gradle.api.Project project, java.util.Map<java.lang.String,java.lang.Object> context, java.lang.String... taskDependencies) Configures Velocity template instantiation.
static com.brambolt.gradle.velocity.tasks.Velocity	configureVelocityTask(org.gradle.api.Project project, java.lang.String inputPath, java.util.Map<java.lang.String,java.lang.Object> context, java.util.List<java.lang.String> taskDependencies) Configures Velocity template instantiation.
static com.brambolt.gradle.velocity.tasks.Velocity	configureVelocityTask(org.gradle.api.Project project, java.lang.String inputPath, java.util.Map<java.lang.String,java.lang.Object> context, java.lang.String... taskDependencies) Configures Velocity template instantiation.
static com.brambolt.gradle.velocity.tasks.Velocity	configureVelocityTask(org.gradle.api.Project project, java.lang.String taskName, java.lang.String inputPath, java.io.File outputDir, java.util.Map<java.lang.String,java.lang.Object> context, java.util.List<java.lang.String> taskDependencies) Configures Velocity template instantiation.
static com.brambolt.gradle.velocity.tasks.Velocity	configureVelocityTask(org.gradle.api.Project project, java.lang.String taskName, java.lang.String inputPath, java.io.File outputDir, java.util.Map<java.lang.String,java.lang.Object> context, java.lang.String... taskDependencies) Configures Velocity template instantiation.
static java.io.File	getDefaultOutputDir(org.gradle.api.Project project) Produces the default output directory for template instantiation.
static java.util.Map<java.lang.String,java.lang.Object>	getDefaultVelocityContext(org.gradle.api.Project project) Produdes the default Velocity context.
static org.gradle.api.tasks.SourceSet	getMainSourceSet(org.gradle.api.Project project) Accessor for the main source set.
static java.util.List<java.lang.String>	getResourcePaths(org.gradle.api.Project project) Accessor for the resource paths.
static org.gradle.api.tasks.SourceSet	getSourceSet(org.gradle.api.Project project, java.lang.String name) Accessor for the parameter source set.
static org.gradle.api.tasks.SourceSetContainer	getSourceSets(org.gradle.api.Project project) Shorthand for accessing the project source sets.
static org.gradle.api.tasks.SourceSet	getTestSourceSet(org.gradle.api.Project project) Accessor for the test source set.

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_IDS

public java.util.List<java.lang.String> PLUGIN_IDS

The plugins to apply to the project.

REQUIRED_PROPERTIES

public static final java.util.List<java.lang.String> REQUIRED_PROPERTIES

The project-specific properties that must be set.

Constructor Detail

ArchiveBuildPlugin

public ArchiveBuildPlugin()

Method Detail

apply

public void apply(org.gradle.api.Project project)

Applies the plugin and configures the build.

Specified by:

apply in interface org.gradle.api.Plugin<org.gradle.api.Project>

Parameters:

project - The project to configure

configurePluginInclusion

public static void configurePluginInclusion(java.util.Map<java.lang.String,java.util.function.Predicate<org.gradle.api.Project>> pluginInclusion)

Configures plugin inclusion.

Parameters:

pluginInclusion - The predicate map to set up.

configureVelocityTask

public static com.brambolt.gradle.velocity.tasks.Velocity configureVelocityTask(org.gradle.api.Project project,
                                                                                java.lang.String taskName,
                                                                                java.lang.String inputPath,
                                                                                java.io.File outputDir,
                                                                                java.util.Map<java.lang.String,java.lang.Object> context,
                                                                                java.util.List<java.lang.String> taskDependencies)

Configures Velocity template instantiation.

Parameters:

project - The project to build.

taskName - The Velocity task name.

inputPath - The Velocity instantiation input path.

outputDir - The Velocity instantiation output directory.

context - The Velocity context.

taskDependencies - Dependencies for the Velocity task.

Returns:

The configured Velocity task.

configureVelocityTask

public static com.brambolt.gradle.velocity.tasks.Velocity configureVelocityTask(org.gradle.api.Project project,
                                                                                java.lang.String taskName,
                                                                                java.lang.String inputPath,
                                                                                java.io.File outputDir,
                                                                                java.util.Map<java.lang.String,java.lang.Object> context,
                                                                                java.lang.String... taskDependencies)

Configures Velocity template instantiation.

Parameters:

project - The project to build.

taskName - The Velocity task name.

inputPath - The Velocity instantiation input path.

outputDir - The Velocity instantiation output directory.

context - The Velocity context.

taskDependencies - Dependencies for the Velocity task.

Returns:

The configured Velocity task.

configureVelocityTask

public static com.brambolt.gradle.velocity.tasks.Velocity configureVelocityTask(org.gradle.api.Project project,
                                                                                java.lang.String inputPath,
                                                                                java.util.Map<java.lang.String,java.lang.Object> context,
                                                                                java.util.List<java.lang.String> taskDependencies)

Configures Velocity template instantiation.

Parameters:

project - The project to build.

inputPath - The Velocity instantiation input path.

context - The Velocity context.

taskDependencies - Dependencies for the Velocity task.

Returns:

The configured Velocity task.

getDefaultOutputDir

public static java.io.File getDefaultOutputDir(org.gradle.api.Project project)

Produces the default output directory for template instantiation.

Parameters:

project - The project being built.

Returns:

The default output directory for template instantiation.

configureVelocityTask

public static com.brambolt.gradle.velocity.tasks.Velocity configureVelocityTask(org.gradle.api.Project project,
                                                                                java.util.Map<java.lang.String,java.lang.Object> context,
                                                                                java.util.List<java.lang.String> taskDependencies)

Configures Velocity template instantiation.

Parameters:

project - The project to build.

context - The Velocity context.

taskDependencies - Dependencies for the Velocity task.

Returns:

The configured Velocity task.

configureVelocityTask

public static com.brambolt.gradle.velocity.tasks.Velocity configureVelocityTask(org.gradle.api.Project project,
                                                                                java.lang.String inputPath,
                                                                                java.util.Map<java.lang.String,java.lang.Object> context,
                                                                                java.lang.String... taskDependencies)

Configures Velocity template instantiation.

Parameters:

project - The project to build.

inputPath - The input path for template instantiation.

context - The Velocity context.

taskDependencies - Dependencies for the Velocity task.

Returns:

The configured Velocity task.

configureVelocityTask

public static com.brambolt.gradle.velocity.tasks.Velocity configureVelocityTask(org.gradle.api.Project project,
                                                                                java.util.Map<java.lang.String,java.lang.Object> context,
                                                                                java.lang.String... taskDependencies)

Configures Velocity template instantiation.

Parameters:

project - The project to build.

context - The Velocity context.

taskDependencies - Dependencies for the Velocity task.

Returns:

The configured Velocity task.

configureVelocityTask

public static com.brambolt.gradle.velocity.tasks.Velocity configureVelocityTask(org.gradle.api.Project project,
                                                                                java.util.Map<java.lang.String,java.lang.Object> context)

Configures Velocity template instantiation.

Parameters:

project - The project to build.

context - The Velocity context.

Returns:

The configured Velocity task.

configureVelocityTask

public static com.brambolt.gradle.velocity.tasks.Velocity configureVelocityTask(org.gradle.api.Project project)

Configures Velocity template instantiation.

Parameters:

project - The project to build.

Returns:

The configured Velocity task.

getDefaultVelocityContext

public static java.util.Map<java.lang.String,java.lang.Object> getDefaultVelocityContext(org.gradle.api.Project project)

Produdes the default Velocity context.

Parameters:

project - The project being built.

Returns:

The default Velocity context.

configureResourcePaths

public static void configureResourcePaths(org.gradle.api.Project project)

Sets the main source set resource paths to the default values.

Parameters:

project - The project being built.

configureResourcePaths

public static void configureResourcePaths(org.gradle.api.Project project,
                                          java.util.List<java.lang.String> resourcePaths)

Sets the main source set resource paths.

Parameters:

project - The project being built.

resourcePaths - The resource paths ot use for the main source set.

getResourcePaths

public static java.util.List<java.lang.String> getResourcePaths(org.gradle.api.Project project)

Accessor for the resource paths.

Parameters:

project - The project being built.

Returns:

The resource paths.

configureMainSourceSetResourcePaths

public static void configureMainSourceSetResourcePaths(org.gradle.api.Project project,
                                                       java.lang.String... srcDirsPaths)

Sets the source directories for the main source set.

Parameters:

project - The project being built.

srcDirsPaths - The source directories to use.

configureMainSourceSetResourcePaths

public static void configureMainSourceSetResourcePaths(org.gradle.api.Project project,
                                                       java.util.List<java.lang.String> srcDirsPaths)

Sets the source directories for the main source set.

Parameters:

project - The project being built.

srcDirsPaths - The source directories to use.

getSourceSets

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

Shorthand for accessing the project source sets.

Parameters:

project - The project being build.

Returns:

The project source sets.

Throws:

org.gradle.api.GradleException - If no source sets are configured.

getMainSourceSet

public static org.gradle.api.tasks.SourceSet getMainSourceSet(org.gradle.api.Project project)

Accessor for the main source set.

Parameters:

project - The project being built.

Returns:

The main source set.

getTestSourceSet

public static org.gradle.api.tasks.SourceSet getTestSourceSet(org.gradle.api.Project project)

Accessor for the test source set.

Parameters:

project - The project being built.

Returns:

The test source set.

getSourceSet

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

Accessor for the parameter source set.

Parameters:

project - The project being built.

name - The source set name.

Returns:

The source set with the parameter name.

configureProcessResourcesTask

public static void configureProcessResourcesTask(org.gradle.api.Project project,
                                                 java.util.Map<java.lang.String,java.lang.Object> replaceTokens)

Configures the processResources task.

Parameters:

project - The project being built.

replaceTokens - The optional replacements tokens to use

configureProcessResourcesTask

public static void configureProcessResourcesTask(org.gradle.api.Project project,
                                                 java.lang.String... taskDependencies)

Configures the processResources task.

Parameters:

project - The project being built.

taskDependencies - Dependencies for the process resources task.

configureProcessResourcesTask

public static void configureProcessResourcesTask(org.gradle.api.Project project,
                                                 java.util.List<java.lang.String> taskDependencies)

Configures the processResources task.

Parameters:

project - The project being built.

taskDependencies - Dependencies for the process resources task.

configureProcessResourcesTask

public static void configureProcessResourcesTask(org.gradle.api.Project project,
                                                 java.util.Map<java.lang.String,java.lang.Object> replaceTokens,
                                                 java.util.List<java.lang.String> taskDependencies)

Configures the processResources task.

Parameters:

project - The project being built.

replaceTokens - The optional replacements tokens to use

taskDependencies - Dependencies for the process resources task.