GradleUtilsExtension (GradleUtils 2.4.19 API)

net.minecraftforge.gradleutils.GradleUtilsExtension

```
@groovy.transform.CompileStatic
class GradleUtilsExtension
extends java.lang.Object
```
The heart of the GradleUtils library. This class can be directly accessed from buildscripts that have the {
linkplain:
GradleUtilsPlugin plugin} applied using gradleutils.

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`NAME`
`PomUtils`	`pom`	Holds a project-aware Pom utilities class, useful for configuring repositories and publishing.

Properties Summary

Properties
Type	Name and description
`java.util.Map<java.lang.String, java.lang.String>`	`gitInfo` deprecated: Use net.minecraftforge.gitver.api.GitVersion#getInfo() GitVersion.getInfo() via GitVersionExtension.getVersion instead.
`org.gradle.api.file.DirectoryProperty`	`gitRoot` deprecated: Use net.minecraftforge.gitver.api.GitVersion#getRoot() GitVersion.getRoot() via GitVersionExtension.getVersion instead.

Constructor Summary

Constructors
Constructor and description
`GradleUtilsExtension (org.gradle.api.Project project, org.gradle.api.provider.ProviderFactory providers, org.gradle.api.model.ObjectFactory objects)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`getFilteredMCTagOffsetBranchVersion(boolean prefix, java.lang.String filter, java.lang.String mcVersion, java.lang.String[] allowedBranches)` This method has been deprecated in favor of usage of GitVersion.
	`java.lang.String`	`getFilteredTagOffsetBranchVersion(boolean prefix, java.lang.String filter, java.lang.String[] allowedBranches)` This method has been deprecated in favor of usage of GitVersion.
	`java.lang.String`	`getFilteredTagOffsetVersion(boolean prefix, java.lang.String filter)` This method has been deprecated in favor of usage of GitVersion.
	`static org.gradle.api.Action<? super org.gradle.api.artifacts.repositories.MavenArtifactRepository>`	`getForgeMaven()` See Also: GradleUtils.getForgeMaven
	`static org.gradle.api.Action<? super org.gradle.api.artifacts.repositories.MavenArtifactRepository>`	`getForgeReleaseMaven()` See Also: GradleUtils.getForgeReleaseMaven
	`static org.gradle.api.Action<? super org.gradle.api.artifacts.repositories.MavenArtifactRepository>`	`getForgeSnapshotMaven()` See Also: GradleUtils.getForgeSnapshotMaven
	`java.lang.String`	`getMCTagOffsetBranchVersion(java.lang.String mcVersion, java.lang.String[] allowedBranches)` This method has been deprecated in favor of usage of GitVersion.
	`static org.gradle.api.Action<? super org.gradle.api.artifacts.repositories.MavenArtifactRepository>`	`getMinecraftLibsMaven()` See Also: GradleUtils.getMinecraftLibsMaven
	`org.gradle.api.Action<? super org.gradle.api.artifacts.repositories.MavenArtifactRepository>`	`getPublishingForgeMaven(java.io.File defaultFolder)` See Also: GradleUtils.getPublishingForgeMaven
	`java.lang.String`	`getTagOffsetBranchVersion(java.lang.String[] allowedBranches)` This method has been deprecated in favor of usage of GitVersion.
	`java.lang.String`	`getTagOffsetVersion()` This method has been deprecated in favor of usage of GitVersion.

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()`

- Field Detail
  - public static final java.lang.String NAME
  - public final PomUtils pom
    
    Holds a project-aware Pom utilities class, useful for configuring repositories and publishing.
- Property Detail
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) @groovy.lang.Lazy java.util.Map<java.lang.String, java.lang.String> gitInfo
    
    deprecated:
    Use net.minecraftforge.gitver.api.GitVersion#getInfo() GitVersion.getInfo() via GitVersionExtension.getVersion instead.
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) @groovy.lang.Lazy org.gradle.api.file.DirectoryProperty gitRoot
    
    deprecated:
    Use net.minecraftforge.gitver.api.GitVersion#getRoot() GitVersion.getRoot() via GitVersionExtension.getVersion instead.
- Constructor Detail
  - @javax.inject.Inject GradleUtilsExtension(org.gradle.api.Project project, org.gradle.api.provider.ProviderFactory providers, org.gradle.api.model.ObjectFactory objects)
- Method Detail
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) java.lang.String getFilteredMCTagOffsetBranchVersion(boolean prefix, java.lang.String filter, java.lang.String mcVersion, java.lang.String[] allowedBranches)
    
    This method has been deprecated in favor of usage of GitVersion.
```
     // Before:
     version = gradleutils.getMCTagOffsetBranchVersion('1.21.4')

     // After:
     version = gitversion.version.getMCTagOffsetBranch('1.21.4')
 
```
    You must declare your filters in the Git Version config file!.
    deprecated:
    Use net.minecraftforge.gitver.api.GitVersion#getMCTagOffsetBranch(String, String ...) GitVersion.getMCTagOffsetBranch(String, String...) instead.
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) java.lang.String getFilteredTagOffsetBranchVersion(boolean prefix, java.lang.String filter, java.lang.String[] allowedBranches)
    
    This method has been deprecated in favor of usage of GitVersion.
```
     // Before:
     version = gradleutils.tagOffsetBranchVersion

     // After:
     version = gitversion.version.tagOffsetBranch
 
```
    You must declare your filters in the Git Version config file!.
    deprecated:
    Use net.minecraftforge.gitver.api.GitVersion#getTagOffset() instead.
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) java.lang.String getFilteredTagOffsetVersion(boolean prefix, java.lang.String filter)
    
    This method has been deprecated in favor of usage of GitVersion.
```
     // Before:
     version = gradleutils.tagOffsetVersion

     // After:
     version = gitversion.version.tagOffset
 
```
    You must declare your filters in the Git Version config file!.
    deprecated:
    Use net.minecraftforge.gitver.api.GitVersion#getTagOffset() instead.
  - static org.gradle.api.Action<? super org.gradle.api.artifacts.repositories.MavenArtifactRepository> getForgeMaven()
    
    See Also:
    GradleUtils.getForgeMaven
  - static org.gradle.api.Action<? super org.gradle.api.artifacts.repositories.MavenArtifactRepository> getForgeReleaseMaven()
    
    See Also:
    GradleUtils.getForgeReleaseMaven
  - static org.gradle.api.Action<? super org.gradle.api.artifacts.repositories.MavenArtifactRepository> getForgeSnapshotMaven()
    
    See Also:
    GradleUtils.getForgeSnapshotMaven
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) java.lang.String getMCTagOffsetBranchVersion(java.lang.String mcVersion, java.lang.String[] allowedBranches)
    
    This method has been deprecated in favor of usage of GitVersion.
```
     // Before:
     version = gradleutils.getMCTagOffsetBranchVersion('1.21.4')

     // After:
     version = gitversion.version.getMCTagOffsetBranch('1.21.4')
 
```
    deprecated:
    Use net.minecraftforge.gitver.api.GitVersion#getMCTagOffsetBranch(String, String ...) GitVersion.getMCTagOffsetBranch(String, String...) instead.
  - static org.gradle.api.Action<? super org.gradle.api.artifacts.repositories.MavenArtifactRepository> getMinecraftLibsMaven()
    
    See Also:
    GradleUtils.getMinecraftLibsMaven
  - org.gradle.api.Action<? super org.gradle.api.artifacts.repositories.MavenArtifactRepository> getPublishingForgeMaven(java.io.File defaultFolder)
    
    See Also:
    GradleUtils.getPublishingForgeMaven
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) java.lang.String getTagOffsetBranchVersion(java.lang.String[] allowedBranches)
    
    This method has been deprecated in favor of usage of GitVersion.
```
     // Before:
     version = gradleutils.getTagOffsetBranchVersion()

     // After:
     version = gitversion.version.tagOffsetBranch
 
```
    deprecated:
    Use net.minecraftforge.gitver.api.GitVersion#getTagOffsetBranch(String ...) GitVersion.getTagOffsetBranch(String...) instead.
  - @java.lang.Deprecated(forRemoval: true, since: 2.4) java.lang.String getTagOffsetVersion()
    
    This method has been deprecated in favor of usage of GitVersion.
```
     // Before:
     version = gradleutils.tagOffsetVersion

     // After:
     version = gitversion.version.tagOffset
 
```
    deprecated:
    Use net.minecraftforge.gitver.api.GitVersion#getTagOffset() instead.

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class GradleUtilsExtension

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String NAME

public final PomUtils pom

Property Detail

@java.lang.Deprecated(forRemoval: true, since: 2.4) @groovy.lang.Lazy java.util.Map<java.lang.String, java.lang.String> gitInfo

@java.lang.Deprecated(forRemoval: true, since: 2.4) @groovy.lang.Lazy org.gradle.api.file.DirectoryProperty gitRoot

Constructor Detail

@javax.inject.Inject GradleUtilsExtension(org.gradle.api.Project project, org.gradle.api.provider.ProviderFactory providers, org.gradle.api.model.ObjectFactory objects)

Method Detail

@java.lang.Deprecated(forRemoval: true, since: 2.4) java.lang.String getFilteredMCTagOffsetBranchVersion(boolean prefix, java.lang.String filter, java.lang.String mcVersion, java.lang.String[] allowedBranches)

@java.lang.Deprecated(forRemoval: true, since: 2.4) java.lang.String getFilteredTagOffsetBranchVersion(boolean prefix, java.lang.String filter, java.lang.String[] allowedBranches)

@java.lang.Deprecated(forRemoval: true, since: 2.4) java.lang.String getFilteredTagOffsetVersion(boolean prefix, java.lang.String filter)

static org.gradle.api.Action<? super org.gradle.api.artifacts.repositories.MavenArtifactRepository> getForgeMaven()

static org.gradle.api.Action<? super org.gradle.api.artifacts.repositories.MavenArtifactRepository> getForgeReleaseMaven()

static org.gradle.api.Action<? super org.gradle.api.artifacts.repositories.MavenArtifactRepository> getForgeSnapshotMaven()

@java.lang.Deprecated(forRemoval: true, since: 2.4) java.lang.String getMCTagOffsetBranchVersion(java.lang.String mcVersion, java.lang.String[] allowedBranches)

static org.gradle.api.Action<? super org.gradle.api.artifacts.repositories.MavenArtifactRepository> getMinecraftLibsMaven()

org.gradle.api.Action<? super org.gradle.api.artifacts.repositories.MavenArtifactRepository> getPublishingForgeMaven(java.io.File defaultFolder)

@java.lang.Deprecated(forRemoval: true, since: 2.4) java.lang.String getTagOffsetBranchVersion(java.lang.String[] allowedBranches)

@java.lang.Deprecated(forRemoval: true, since: 2.4) java.lang.String getTagOffsetVersion()