GradleUtils (gradleutils 2.6.6 API)

net.minecraftforge.gradleutils.GradleUtils

@groovy.transform.CompileStatic
@java.lang.Deprecated(forRemoval: true, since: 2.5)
@ApiStatus.ScheduledForRemoval(inVersion: 3.0)
class GradleUtils
extends java.lang.Object

Utility methods, usually for GradleUtils itself and is often delegated to from the extension.

See Also:: GradleUtilsExtension

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`GradleUtils.DisableSystemConfig`	deprecated: Use {@link GitVersion#disableSystemConfig()

Constructor Summary

Constructors
Constructor and description
`GradleUtils ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static java.lang.String`	`buildProjectUrl(java.lang.String project)` See Also: net.minecraftforge.gitver.internal.GitUtils#buildProjectUrl(String) GitUtils.buildProjectUrl(String)
	`static java.lang.String`	`buildProjectUrl(java.lang.String organization, java.lang.String project)` See Also: net.minecraftforge.gitver.internal.GitUtils#buildProjectUrl(String, String) GitUtils.buildProjectUrl(String, String)
	`static java.lang.String`	`buildProjectUrl(org.eclipse.jgit.api.Git git)` Identical to net.minecraftforge.gitver.internal.GitUtils#buildProjectUrl(Git) GitUtils.buildProjectUrl(Git).
	`static void`	`ensureAfterEvaluate(org.gradle.api.Project project, Action<? super Project> action)`
	`static java.lang.String`	`getFilteredMCTagOffsetBranchVersion(java.util.Map<java.lang.String, java.lang.String> info, boolean prefix, java.lang.String filter, java.lang.String mcVersion, java.lang.String[] allowedBranches)` deprecated: Filters for GitVersion should be set early, using one of the methods in GradleUtilsExtension
	`static java.lang.String`	`getFilteredTagOffsetBranchVersion(java.util.Map<java.lang.String, java.lang.String> info, boolean prefix, java.lang.String filter, java.lang.String[] allowedBranches)` deprecated: Filters can no longer be defined at configuration.
	`static java.lang.String`	`getFilteredTagOffsetVersion(java.util.Map<java.lang.String, java.lang.String> info, boolean prefix, java.lang.String filter)` deprecated: Filters can no longer be defined at configuration.
	`static groovy.lang.Closure`	`getForgeMaven()` Get a configuring action for the Forge maven to be passed into org.gradle.api.artifacts.dsl.RepositoryHandler#maven(Action) RepositoryHandler.maven(Action) in a repositories block.
	`static groovy.lang.Closure`	`getForgeReleaseMaven()` Get a configuring action for the Forge releases maven to be passed into org.gradle.api.artifacts.dsl.RepositoryHandler#maven(Action) RepositoryHandler.maven(Action) in a repositories block.
	`static groovy.lang.Closure`	`getForgeSnapshotMaven()` Get a configuring action for the Forge snapshots maven to be passed into org.gradle.api.artifacts.dsl.RepositoryHandler#maven(Action) RepositoryHandler.maven(Action) in a repositories block.
	`static java.lang.String`	`getMCTagOffsetBranchVersion(java.util.Map<java.lang.String, java.lang.String> info, java.lang.String mcVersion, java.lang.String[] allowedBranches)` Returns a version in the form { code: $mcVersion-$tag.
	`static groovy.lang.Closure`	`getMinecraftLibsMaven()` Get a configuring action for the Minecraft libraries maven to be passed into org.gradle.api.artifacts.dsl.RepositoryHandler#maven(Action) RepositoryHandler.maven(Action) in a repositories block.
	`static Action<? super MavenArtifactRepository>`	`getPublishingForgeMaven(org.gradle.api.Project project, java.io.File defaultFolder)` Get a configuring action to be passed into org.gradle.api.artifacts.dsl.RepositoryHandler#maven(Action) RepositoryHandler.maven(Action) in a publishing block.
	`static java.lang.String`	`getTagOffsetBranchVersion(java.util.Map<java.lang.String, java.lang.String> info, java.lang.String[] allowedBranches)` Returns a version in the form { code: $tag.
	`static java.lang.String`	`getTagOffsetVersion(java.util.Map<java.lang.String, java.lang.String> info)` Returns a version in the form { code: $tag.
	`static java.util.Map<java.lang.String, java.lang.String>`	`gitInfo(java.io.File dir, java.lang.String[] globFilters)` deprecated: Use GitVersion#getInfo()#getInfo() via GitVersionExtension.getVersion
	`static java.util.List<java.lang.String>`	`rsplit(java.lang.String input, java.lang.String del, int limit)`
	`static void`	`setupCITasks(org.gradle.api.Project project)` Configures CI related tasks for TeamCity.
	`static Action<? super MavenArtifactRepository>`	`setupSnapshotCompatiblePublishing(org.gradle.api.Project project, java.lang.String fallbackPublishingEndpoint, java.io.File defaultFolder, java.io.File defaultSnapshotFolder)` Get a configuring action to be passed into org.gradle.api.artifacts.dsl.RepositoryHandler#maven(Action) RepositoryHandler.maven(Action) in a publishing block.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - GradleUtils()
- Method Detail
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.lang.String buildProjectUrl(java.lang.String project)
    
    See Also:
    net.minecraftforge.gitver.internal.GitUtils#buildProjectUrl(String) GitUtils.buildProjectUrl(String)
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.lang.String buildProjectUrl(java.lang.String organization, java.lang.String project)
    
    See Also:
    net.minecraftforge.gitver.internal.GitUtils#buildProjectUrl(String, String) GitUtils.buildProjectUrl(String, String)
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.lang.String buildProjectUrl(org.eclipse.jgit.api.Git git)
    
    Identical to net.minecraftforge.gitver.internal.GitUtils#buildProjectUrl(Git) GitUtils.buildProjectUrl(Git). The only difference is that this does not return null to preserve GradleUtils 2.x behavior.
    deprecated:
    Replaced by GitVersion, use GitVersion#getUrl()#getUrl() via GitVersionExtension.getVersion
  - static void ensureAfterEvaluate(org.gradle.api.Project project, Action<? super Project> action)
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.lang.String getFilteredMCTagOffsetBranchVersion(java.util.Map<java.lang.String, java.lang.String> info, boolean prefix, java.lang.String filter, java.lang.String mcVersion, java.lang.String[] allowedBranches)
    
    deprecated:
    Filters for GitVersion should be set early, using one of the methods in GradleUtilsExtension
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.lang.String getFilteredTagOffsetBranchVersion(java.util.Map<java.lang.String, java.lang.String> info, boolean prefix, java.lang.String filter, java.lang.String[] allowedBranches)
    
    deprecated:
    Filters can no longer be defined at configuration. Use the Git Version config.
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.lang.String getFilteredTagOffsetVersion(java.util.Map<java.lang.String, java.lang.String> info, boolean prefix, java.lang.String filter)
    
    deprecated:
    Filters can no longer be defined at configuration. Use the Git Version config.
  - static groovy.lang.Closure getForgeMaven()
    
    Get a configuring action for the Forge maven to be passed into org.gradle.api.artifacts.dsl.RepositoryHandler#maven(Action) RepositoryHandler.maven(Action) in a repositories block.
    Returns:
    The action
  - static groovy.lang.Closure getForgeReleaseMaven()
    
    Get a configuring action for the Forge releases maven to be passed into org.gradle.api.artifacts.dsl.RepositoryHandler#maven(Action) RepositoryHandler.maven(Action) in a repositories block.
    Returns:
    The action
  - static groovy.lang.Closure getForgeSnapshotMaven()
    
    Get a configuring action for the Forge snapshots maven to be passed into org.gradle.api.artifacts.dsl.RepositoryHandler#maven(Action) RepositoryHandler.maven(Action) in a repositories block.
    Returns:
    The action
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.lang.String getMCTagOffsetBranchVersion(java.util.Map<java.lang.String, java.lang.String> info, java.lang.String mcVersion, java.lang.String[] allowedBranches)
    
    Returns a version in the form $mcVersion-$tag.$offset, optionally with the branch appended if it is not in the defined list of allowed branches
    deprecated:
    Use GitVersion#getMCTagOffsetBranch(String, String ...) instead
    
    Parameters:
    info - A git info object generated from #gitInfo
    mcVersion - The current minecraft version
    allowedBranches - A list of allowed branches; the current branch is appended if not in this list
    Returns:
    a version in the form \$mcVersion-\$tag.\$offset or \$mcVersion-\$tag.\$offset-\$branch
  - static groovy.lang.Closure getMinecraftLibsMaven()
    
    Get a configuring action for the Minecraft libraries maven to be passed into org.gradle.api.artifacts.dsl.RepositoryHandler#maven(Action) RepositoryHandler.maven(Action) in a repositories block.
    Returns:
    The action
  - static Action<? super MavenArtifactRepository> getPublishingForgeMaven(org.gradle.api.Project project, java.io.File defaultFolder)
    
    Get a configuring action to be passed into org.gradle.api.artifacts.dsl.RepositoryHandler#maven(Action) RepositoryHandler.maven(Action) 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
    - MAVEN_URL_RELEASE: Containing the URL to use for the release repository
    - MAVEN_URL_SNAPSHOT: Containing the URL to use for the snapshot repository
    Parameters:
    project - The project to setup publishing for
    defaultFolder - The default folder if the required maven information is not set
    Returns:
    The action
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.lang.String getTagOffsetBranchVersion(java.util.Map<java.lang.String, java.lang.String> info, java.lang.String[] allowedBranches)
    
    Returns a version in the form $tag.$offset, optionally with the branch appended if it is not in the defined list of allowed branches
    deprecated:
    Use GitVersion#getTagOffsetBranch(String ...) via GitVersionExtension.getVersion
    
    Parameters:
    info - A git info object generated from gitInfo(File, String ...)
    allowedBranches - A list of allowed branches; the current branch is appended if not in this list
    Returns:
    a version in the form \$tag.\$offset or \$tag.\$offset-\$branch
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.lang.String getTagOffsetVersion(java.util.Map<java.lang.String, java.lang.String> info)
    
    Returns a version in the form $tag.$offset, e.g. 1.0.5
    deprecated:
    Use GitVersion#getTagOffset()#getTagOffset() instead
    
    Parameters:
    info - A git info object generated from #gitInfo
    Returns:
    a version in the form \$tag.\$offset, e.g. 1.0.5
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.util.Map<java.lang.String, java.lang.String> gitInfo(java.io.File dir, java.lang.String[] globFilters)
    
    deprecated:
    Use GitVersion#getInfo()#getInfo() via GitVersionExtension.getVersion
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) @org.jetbrains.annotations.Nullable static java.util.List<java.lang.String> rsplit(@org.jetbrains.annotations.Nullable java.lang.String input, java.lang.String del, int limit)
  - @java.lang.Deprecated(forRemoval: true) static void setupCITasks(org.gradle.api.Project project)
    
    Configures CI related tasks for TeamCity.
    deprecated:
    Once Forge has completely moved off of TeamCity, this will be deleted. New tasks added to GradleUtils should handle registration themselves.
    
    Parameters:
    project - The project to configure TeamCity tasks for
  - static Action<? super MavenArtifactRepository> setupSnapshotCompatiblePublishing(org.gradle.api.Project project, java.lang.String fallbackPublishingEndpoint, java.io.File defaultFolder, java.io.File defaultSnapshotFolder)
    
    Get a configuring action to be passed into org.gradle.api.artifacts.dsl.RepositoryHandler#maven(Action) RepositoryHandler.maven(Action) in a publishing block. This action respects the current project's version, with regards to publishing to a release or snapshot repository.
    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
    - MAVEN_URL_SNAPSHOT: Containing the URL to use for the snapshot repository
    If the MAVEN_URL_RELEASE variable is not set, the passed in fallback URL will be used for the release repository (by default, this is https://maven.minecraftforge.net/). This is done to preserve backwards compatibility with the old getPublishingForgeMaven(Project, File) method.
    Parameters:
    project - The project to setup publishing for
    defaultFolder - The default folder if the required maven information is not set
    Returns:
    The action

Summary:
Nested
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class GradleUtils

Nested Class Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

GradleUtils()

Method Detail

@java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.lang.String buildProjectUrl(java.lang.String project)

@java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.lang.String buildProjectUrl(java.lang.String organization, java.lang.String project)

@java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.lang.String buildProjectUrl(org.eclipse.jgit.api.Git git)

static void ensureAfterEvaluate(org.gradle.api.Project project, Action<? super Project> action)

@java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.lang.String getFilteredTagOffsetBranchVersion(java.util.Map<java.lang.String, java.lang.String> info, boolean prefix, java.lang.String filter, java.lang.String[] allowedBranches)

@java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.lang.String getFilteredTagOffsetVersion(java.util.Map<java.lang.String, java.lang.String> info, boolean prefix, java.lang.String filter)

static groovy.lang.Closure getForgeMaven()

static groovy.lang.Closure getForgeReleaseMaven()

static groovy.lang.Closure getForgeSnapshotMaven()

@java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.lang.String getMCTagOffsetBranchVersion(java.util.Map<java.lang.String, java.lang.String> info, java.lang.String mcVersion, java.lang.String[] allowedBranches)

static groovy.lang.Closure getMinecraftLibsMaven()

static Action<? super MavenArtifactRepository> getPublishingForgeMaven(org.gradle.api.Project project, java.io.File defaultFolder)

@java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.lang.String getTagOffsetBranchVersion(java.util.Map<java.lang.String, java.lang.String> info, java.lang.String[] allowedBranches)

@java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.lang.String getTagOffsetVersion(java.util.Map<java.lang.String, java.lang.String> info)

@java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) static java.util.Map<java.lang.String, java.lang.String> gitInfo(java.io.File dir, java.lang.String[] globFilters)

@java.lang.Deprecated(forRemoval: true, since: 2.4) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) @org.jetbrains.annotations.Nullable static java.util.List<java.lang.String> rsplit(@org.jetbrains.annotations.Nullable java.lang.String input, java.lang.String del, int limit)

@java.lang.Deprecated(forRemoval: true) static void setupCITasks(org.gradle.api.Project project)

static Action<? super MavenArtifactRepository> setupSnapshotCompatiblePublishing(org.gradle.api.Project project, java.lang.String fallbackPublishingEndpoint, java.io.File defaultFolder, java.io.File defaultSnapshotFolder)