Property Detail

• static final java.lang.String SHADOW_PLUGIN_ID

• static final java.lang.String SHADOW_PLUGIN_INCLUSION

• static final java.lang.String SNAPSHOT

• java.util.List<java.lang.String> pluginIds

  The plugins to apply to the plugin build project.

• java.util.Map<java.lang.String, java.lang.String> pluginInclusion

  Maps plugin identifier to project property. If a plugin identifier is included in this map then the plugin will only be applied if the project property is present with a non-empty value.

• java.util.List<java.lang.String> requiredProperties

  The project-specific properties that must be set.

Method Detail

• @java.lang.Override void apply(org.gradle.api.Project project)

  Applies the plugin and configures the build.

  Parameters:

  project - The project to configure

• void checkProjectProperties(java.lang.Object project)

  Checks that values have been provided for the required project properties.

  Parameters:

  project - The project to configure

  See Also:

  requiredProperties

• void configureArtifactory(org.gradle.api.Project project)

  Configures Artifactory publishing. Disabled by default. Set artifactoryContextUrl, artifactoryRepoKey, artifactoryUser and artifactoryToken to enable Artifactory publishing.

  Parameters:

  project - The project to configure

• void configureBintray(org.gradle.api.Project project)

  Configures Bintray publishing. Disabled by default. Set bintrayContextUrl, bintrayUser and bintrayKey to enable Bintray publishing.

  Parameters:

  project - The project to configure

• void configureDefaultTasks(org.gradle.api.Project project)

  Configures the local and all tasks and assigns all as the project default.

  Parameters:

  project - The project to configure

• void configureDependencies(org.gradle.api.Project project)

  Adds dependencies.

  Parameters:

  project - The project to configure

• void configureDerivedProperties(org.gradle.api.Project project)

  Defines additional properties that are derived from the required properties.

  Parameters:

  project - The project to configure

• void configureGradlePlugin(org.gradle.api.Project project)

  Configures the Gradle plugin to build and publish.

  Parameters:

  project - The project to configure

• void configureJarTask(org.gradle.api.Project project)

  Configures jar task including manifest attributes.

  Parameters:

  project - The project to configure

• void configureJavaPlugin(org.gradle.api.Project project)

  Configures the Java plugin including source and target compatibility.

  Parameters:

  project - The project to configure

• void configureJavadocJarTask(org.gradle.api.Project project)

  Configures the Javadoc jar task.

  Parameters:

  project - The project to configure

• void configurePlugin(org.gradle.api.Project project, java.lang.String id)

  Applies the plugin identified by the parameter plugin identifier. If the plugin identifier is included as a key in the pluginInclusion map then it will only be applied if the value is present as a property on the project with a non-empty value.

  Parameters:

  project - The project to apply the plugin to

  id - The identifier of the plugin to apply

• void configurePluginBundle(org.gradle.api.Project project)

  Configures the plugin bundle being published.

  Parameters:

  project - The project to configure

• void configurePlugins(org.gradle.api.Project project)

  Applies the plugins in the pluginIds list.

  Parameters:

  project - The project to configure

  See Also:

  pluginIds

• void configurePublishing(org.gradle.api.Project project)

  Configures publishing.

  Parameters:

  project - The project to configure

• void configureRepositories(org.gradle.api.Project project)

  Adds repository definitions.

  Parameters:

  project - The project to configure

• void configureShadowJarTask(org.gradle.api.Project project)

  Configures the shadow jar task.

  Parameters:

  project - The project being configured

• void configureSourceJarTask(org.gradle.api.Project project)

  Configures the source jar task.

  Parameters:

  project - The project to configure

• static boolean isProjectPropertySet(org.gradle.api.Project project, java.lang.String propertyName)

  Checks that the parameter property has a non-empty string or collection value for the parameter property name.

  Parameters:

  project - The project to check

  propertyName - The property name to check

• void logProperties(org.gradle.api.Project project)

  Logs the required and derived project properties.

  Parameters:

  project - The project to configure

• boolean shouldApplyPlugin(org.gradle.api.Project project, java.lang.String pluginId)

  Uses the pluginInclusion map to determine whether the plugin identified by the parameter identifier should be applied to the project. The map associates plugins with project properties; the plugins should be applied if the map either does not contain the identifier (but the plugins list has it) or the map points to a project property with a non-empty value.

  Parameters:

  project - The project being configured

  pluginId - The plugin identifier

  Returns:

  True iff the plugin should be applied to the project

• static boolean shouldBuildShadowJar(org.gradle.api.Project project)

  Checks whether a shadow jar should be built. This is determined by the presence of the buildShadowJar project property, with a non-empty value.

  Parameters:

  project - The project to check

  Returns:

  True iff a shadow jar should be built, else false