public interface JavaPluginExtension
JavaBasePlugin
.Modifier and Type | Method | Description |
---|---|---|
void |
consistentResolution(Action<? super JavaResolutionConsistency> action) |
Configure the dependency resolution consistency for this Java project.
|
void |
disableAutoTargetJvm() |
If this method is called, Gradle will not automatically try to fetch
dependencies which have a JVM version compatible with the target compatibility
of this module.
|
ModularitySpec |
getModularity() |
Configure the module path handling for tasks that have a 'classpath' as input.
|
JavaVersion |
getSourceCompatibility() |
Returns the source compatibility used for compiling Java sources.
|
JavaVersion |
getTargetCompatibility() |
Returns the target compatibility used for compiling Java sources.
|
JavaToolchainSpec |
getToolchain() |
Gets the project wide toolchain requirements that will be used for tasks requiring a tool from the toolchain (e.g.
|
void |
registerFeature(String name,
Action<? super FeatureSpec> configureAction) |
Registers a feature.
|
void |
setSourceCompatibility(JavaVersion value) |
Sets the source compatibility used for compiling Java sources.
|
void |
setTargetCompatibility(JavaVersion value) |
Sets the target compatibility used for compiling Java sources.
|
JavaToolchainSpec |
toolchain(Action<? super JavaToolchainSpec> action) |
Configures the project wide toolchain requirements for tasks that require a tool from the toolchain (e.g.
|
void |
withJavadocJar() |
Adds a task
javadocJar that will package the output of the javadoc task in a JAR with classifier javadoc . |
void |
withSourcesJar() |
Adds a task
sourcesJar that will package the Java sources of the main SourceSet in a JAR with classifier sources . |
JavaVersion getSourceCompatibility()
void setSourceCompatibility(JavaVersion value)
This property cannot be set if a toolchain
has been configured.
value
- The value for the source compatibilitytoolchain(Action)
JavaVersion getTargetCompatibility()
void setTargetCompatibility(JavaVersion value)
This property cannot be set if a toolchain
has been configured.
value
- The value for the target compatibilitytoolchain(Action)
void registerFeature(String name, Action<? super FeatureSpec> configureAction)
name
- the name of the featureconfigureAction
- the configuration for the featurevoid disableAutoTargetJvm()
This should be used whenever the default behavior is not applicable, in particular when for some reason it's not possible to split a module and that this module only has some classes which require dependencies on higher versions.
@Incubating void withJavadocJar()
javadocJar
that will package the output of the javadoc
task in a JAR with classifier javadoc
.
The produced artifact is registered as a documentation variant on the java
component and added as a dependency on the assemble
task.
This means that if maven-publish
or ivy-publish
is also applied, the javadoc JAR will be published.
If the project already has a task named javadocJar
then no task is created.
The publishing of the Javadoc variant can also be disabled using ConfigurationVariantDetails.skip()
through AdhocComponentWithVariants.withVariantsFromConfiguration(Configuration, Action)
,
if it should only be built locally by calling or wiring the ':javadocJar' task.
@Incubating void withSourcesJar()
sourcesJar
that will package the Java sources of the main SourceSet
in a JAR with classifier sources
.
The produced artifact is registered as a documentation variant on the java
component and added as a dependency on the assemble
task.
This means that if maven-publish
or ivy-publish
is also applied, the sources JAR will be published.
If the project already has a task named sourcesJar
then no task is created.
The publishing of the sources variant can be disabled using ConfigurationVariantDetails.skip()
through AdhocComponentWithVariants.withVariantsFromConfiguration(Configuration, Action)
,
if it should only be built locally by calling or wiring the ':sourcesJar' task.
@Incubating ModularitySpec getModularity()
@Incubating JavaToolchainSpec getToolchain()
JavaCompile
).
Configuring a toolchain cannot be used together with sourceCompatibility
or targetCompatibility
on this extension.
Both values will be sourced from the toolchain.
@Incubating JavaToolchainSpec toolchain(Action<? super JavaToolchainSpec> action)
JavaCompile
).
Configuring a toolchain cannot be used together with sourceCompatibility
or targetCompatibility
on this extension.
Both values will be sourced from the toolchain.
@Incubating void consistentResolution(Action<? super JavaResolutionConsistency> action)
action
- the configuration action