Interface GradleUtilsExtension

All Known Subinterfaces:

GradleUtilsExtensionForProject

public sealed interface GradleUtilsExtension
permits GradleUtilsExtensionForProject (not exhaustive)

Contains various utilities for working with Gradle scripts.

See Also:

• GradleUtilsExtensionForProject

Field Summary

Fields

Modifier and Type	Field	Description
static final org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository>	forgeMaven	Deprecated, for removal: This API element is subject to removal in a future version. Use getForgeMaven()
static final org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository>	forgeReleaseMaven	Deprecated, for removal: This API element is subject to removal in a future version. Use getForgeReleaseMaven()
static final org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository>	minecraftLibsMaven	Deprecated, for removal: This API element is subject to removal in a future version. Use getMinecraftLibsMaven()
static final String	NAME	The name for this extension.

Method Summary

Modifier and Type	Method	Description
<T> org.gradle.api.provider.Provider<T>	asProvider(Object value)	Packs a (deferred) value as a provider.
default org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository>	getForgeMaven()	A closure for the Forge maven to be passed into RepositoryHandler.maven(Closure).
default org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository>	getForgeReleaseMaven()	A closure for the Forge releases maven to be passed into RepositoryHandler.maven(Closure).
default org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository>	getMinecraftLibsMaven()	A closure for the Minecraft libraries maven to be passed into RepositoryHandler.maven(Closure).
PomUtils	getPom()	Utilities for working with a MavenPom for publishing artifacts.
default org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository>	getPublishingForgeMaven()	Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.
default org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository>	getPublishingForgeMaven(File defaultFolder)	Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.
org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository>	getPublishingForgeMaven(String fallbackPublishingEndpoint)	Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.
org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository>	getPublishingForgeMaven(String fallbackPublishingEndpoint, File defaultFolder)	Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.
org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository>	getPublishingForgeMaven(String fallbackPublishingEndpoint, Object defaultFolder)	Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.
org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository>	getPublishingForgeMaven(String fallbackPublishingEndpoint, org.gradle.api.file.Directory defaultFolder)	Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.
org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository>	getPublishingForgeMaven(String fallbackPublishingEndpoint, org.gradle.api.provider.Provider<?> defaultFolder)	Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.
default org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository>	getPublishingForgeMaven(org.gradle.api.file.Directory defaultFolder)	Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.
default org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository>	getPublishingForgeMaven(org.gradle.api.provider.Provider<?> defaultFolder)	Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.
default <T> T	unpack(Object value)	Unpacks a deferred value.

Field Details

NAME

static final String NAME

The name for this extension.

See Also:

• Constant Field Values

forgeMaven

@Deprecated(forRemoval=true,
            since="3.3.28")
@ScheduledForRemoval(inVersion="4.0.0")
static final org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository> forgeMaven

Deprecated, for removal: This API element is subject to removal in a future version.

Use getForgeMaven()

forgeReleaseMaven

@Deprecated(forRemoval=true,
            since="3.3.28")
@ScheduledForRemoval(inVersion="4.0.0")
static final org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository> forgeReleaseMaven

Deprecated, for removal: This API element is subject to removal in a future version.

Use getForgeReleaseMaven()

minecraftLibsMaven

@Deprecated(forRemoval=true,
            since="3.3.28")
@ScheduledForRemoval(inVersion="4.0.0")
static final org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository> minecraftLibsMaven

Deprecated, for removal: This API element is subject to removal in a future version.

Use getMinecraftLibsMaven()

Method Details

getForgeMaven

default org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository> getForgeMaven()

A closure for the Forge maven to be passed into RepositoryHandler.maven(Closure).

 repositories {
     maven fg.forgeMaven
 }
 

getForgeReleaseMaven

default org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository> getForgeReleaseMaven()

A closure for the Forge releases maven to be passed into RepositoryHandler.maven(Closure).

 repositories {
     maven fg.forgeReleaseMaven
 }
 

See Also:

• forgeMaven

getMinecraftLibsMaven

default org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository> getMinecraftLibsMaven()

A closure for the Minecraft libraries maven to be passed into RepositoryHandler.maven(Closure).

 repositories {
     maven fg.minecraftLibsMaven
 }
 

getPublishingForgeMaven

default org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository> getPublishingForgeMaven()

Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.

Important: The following environment variables must be set for this to work:

• MAVEN_USER: Containing the username to use for authentication
• MAVEN_PASSWORD: Containing the password to use for authentication

The following environment variables are optional:

• MAVEN_URL(_RELEASE): Containing the URL to use for the release repository
• Please note that since Forge does not have a snapshot repository, snapshot maven publishing via GradleUtils is no longer supported as of 3.0.0.

If the required environment variables are not present, the output Maven will be a local folder named repo on the root of the build directory.

If the MAVEN_URL_RELEASE variable is not set, the Forge releases repository will be used (https://maven.minecraftforge.net/releases).

Returns:

The closure

getPublishingForgeMaven

org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository> getPublishingForgeMaven(String fallbackPublishingEndpoint)

Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.

Important: The following environment variables must be set for this to work:

• MAVEN_USER: Containing the username to use for authentication
• MAVEN_PASSWORD: Containing the password to use for authentication

The following environment variables are optional:

• MAVEN_URL(_RELEASE): Containing the URL to use for the release repository
• Please note that since Forge does not have a snapshot repository, snapshot maven publishing via GradleUtils is no longer supported as of 3.0.0.

If the required environment variables are not present, the output Maven will be a local folder named repo on the root of the build directory.

If the MAVEN_URL_RELEASE variable is not set, the passed in fallback URL will be used for the release repository.

Parameters:

fallbackPublishingEndpoint - The fallback URL for the release repository

Returns:

The closure

getPublishingForgeMaven

org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository> getPublishingForgeMaven(String fallbackPublishingEndpoint,
 Object defaultFolder)

Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block. Important: The following environment variables must be set for this to work:

• MAVEN_USER: Containing the username to use for authentication
• MAVEN_PASSWORD: Containing the password to use for authentication

The following environment variables are optional:

• MAVEN_URL(_RELEASE): Containing the URL to use for the release repository
• Please note that since Forge does not have a snapshot repository, snapshot maven publishing via GradleUtils is no longer supported as of 3.0.0.

If the required environment variables are not present, the output Maven will be set to the given default folder.

If the MAVEN_URL(_RELEASE) variable is not set, the passed in fallback URL will be used for the release repository.

Parameters:

fallbackPublishingEndpoint - The fallback URL for the release repository

defaultFolder - The default folder if the required maven information is not set

Returns:

The closure

getPublishingForgeMaven

default org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository> getPublishingForgeMaven(File defaultFolder)

Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.

Important: The following environment variables must be set for this to work:

• MAVEN_USER: Containing the username to use for authentication
• MAVEN_PASSWORD: Containing the password to use for authentication

The following environment variables are optional:

• MAVEN_URL(_RELEASE): Containing the URL to use for the release repository
• Please note that since Forge does not have a snapshot repository, snapshot maven publishing via GradleUtils is no longer supported as of 3.0.0.

If the required environment variables are not present, the output Maven will be set to the given default folder.

If the MAVEN_URL_RELEASE variable is not set, the Forge releases repository will be used (https://maven.minecraftforge.net/releases).

Parameters:

defaultFolder - The default folder if the required maven information is not set

Returns:

The closure

getPublishingForgeMaven

org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository> getPublishingForgeMaven(String fallbackPublishingEndpoint,
 File defaultFolder)

Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block. Important: The following environment variables must be set for this to work:

• MAVEN_USER: Containing the username to use for authentication
• MAVEN_PASSWORD: Containing the password to use for authentication

The following environment variables are optional:

• MAVEN_URL(_RELEASE): Containing the URL to use for the release repository
• Please note that since Forge does not have a snapshot repository, snapshot maven publishing via GradleUtils is no longer supported as of 3.0.0.

If the required environment variables are not present, the output Maven will be set to the given default folder.

If the MAVEN_URL(_RELEASE) variable is not set, the passed in fallback URL will be used for the release repository.

Parameters:

fallbackPublishingEndpoint - The fallback URL for the release repository

defaultFolder - The default folder if the required maven information is not set

Returns:

The closure

getPublishingForgeMaven

default org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository> getPublishingForgeMaven(org.gradle.api.file.Directory defaultFolder)

Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.

Important: The following environment variables must be set for this to work:

• MAVEN_USER: Containing the username to use for authentication
• MAVEN_PASSWORD: Containing the password to use for authentication

The following environment variables are optional:

• MAVEN_URL(_RELEASE): Containing the URL to use for the release repository
• Please note that since Forge does not have a snapshot repository, snapshot maven publishing via GradleUtils is no longer supported as of 3.0.0.

If the required environment variables are not present, the output Maven will be set to the given default folder.

If the MAVEN_URL_RELEASE variable is not set, the Forge releases repository will be used (https://maven.minecraftforge.net/releases).

Parameters:

defaultFolder - The default folder if the required maven information is not set

Returns:

The closure

getPublishingForgeMaven

org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository> getPublishingForgeMaven(String fallbackPublishingEndpoint,
 org.gradle.api.file.Directory defaultFolder)

Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block. Important: The following environment variables must be set for this to work:

• MAVEN_USER: Containing the username to use for authentication
• MAVEN_PASSWORD: Containing the password to use for authentication

The following environment variables are optional:

• MAVEN_URL(_RELEASE): Containing the URL to use for the release repository
• Please note that since Forge does not have a snapshot repository, snapshot maven publishing via GradleUtils is no longer supported as of 3.0.0.

If the required environment variables are not present, the output Maven will be set to the given default folder.

If the MAVEN_URL(_RELEASE) variable is not set, the passed in fallback URL will be used for the release repository.

Parameters:

fallbackPublishingEndpoint - The fallback URL for the release repository

defaultFolder - The default folder if the required maven information is not set

Returns:

The closure

getPublishingForgeMaven

default org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository> getPublishingForgeMaven(org.gradle.api.provider.Provider<?> defaultFolder)

Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.

Important: The following environment variables must be set for this to work:

• MAVEN_USER: Containing the username to use for authentication
• MAVEN_PASSWORD: Containing the password to use for authentication

The following environment variables are optional:

• MAVEN_URL(_RELEASE): Containing the URL to use for the release repository
• Please note that since Forge does not have a snapshot repository, snapshot maven publishing via GradleUtils is no longer supported as of 3.0.0.

If the required environment variables are not present, the output Maven will be set to the given default folder.

If the MAVEN_URL_RELEASE variable is not set, the Forge releases repository will be used (https://maven.minecraftforge.net/releases).

Parameters:

defaultFolder - The default folder if the required maven information is not set

Returns:

The closure

getPublishingForgeMaven

org.gradle.api.Action<org.gradle.api.artifacts.repositories.MavenArtifactRepository> getPublishingForgeMaven(String fallbackPublishingEndpoint,
 org.gradle.api.provider.Provider<?> defaultFolder)

Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block. Important: The following environment variables must be set for this to work:

• MAVEN_USER: Containing the username to use for authentication
• MAVEN_PASSWORD: Containing the password to use for authentication

The following environment variables are optional:

• MAVEN_URL(_RELEASE): Containing the URL to use for the release repository
• Please note that since Forge does not have a snapshot repository, snapshot maven publishing via GradleUtils is no longer supported as of 3.0.0.

If the required environment variables are not present, the output Maven will be set to the given default folder.

If the MAVEN_URL(_RELEASE) variable is not set, the passed in fallback URL will be used for the release repository.

Parameters:

fallbackPublishingEndpoint - The fallback URL for the release repository

defaultFolder - The default folder if the required maven information is not set

Returns:

The closure

getPom

PomUtils getPom()

Utilities for working with a MavenPom for publishing artifacts.

Returns:

The POM utilities

See Also:

• PomUtils

unpack

default <T> T unpack(Object value)

Unpacks a deferred value.

Since buildscripts are dynamically compiled, this allows buildscript authors to use this method with version catalog entries, other provider-like objects. This prevents the need to arbitrarily call Provider.get() (or similar) on values which may or may not be deferred based on circumstance.

Type Parameters:

T - The type of value held by the provider

Parameters:

value - The value to unpack

Returns:

The unpacked value

asProvider

<T> org.gradle.api.provider.Provider<T> asProvider(Object value)

Packs a (deferred) value as a provider.

Since buildscripts are dynamically compiled, this allows buildscript authors to use this method with version catalog entries, other provider-like objects. This prevents the need to call ProviderConvertible.asProvider() or otherwise create arbitrary providers using ProviderFactory.provider(Callable) on values which may or may not be deferred based on circumstance.

Type Parameters:

T - The type of value held by the provider

Parameters:

value - The value to pack

Returns:

The packed value