Index (Forge Gradle Utilities3.0.0-beta.15)

A C D E F G H I L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values

A

action(Object, Action<? super T>) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Creates a closure backed by the given action.
action(Action<? super T>) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Creates a closure backed by the given action.
actionable(Closure<T>) - Static method in class net.minecraftforge.gradleutils.shared.Lazy: Creates an actionable lazy of the given closure.
actionable(Callable<T>) - Static method in class net.minecraftforge.gradleutils.shared.Lazy: Creates an actionable lazy of the given callable.
addArguments() - Method in class net.minecraftforge.gradleutils.shared.ToolExecBase: This method should be overridden by subclasses to add arguments to this task via JavaExec.args(java.lang.Object...).
addRemoteDetails(MavenPom) - Method in interface net.minecraftforge.gradleutils.PomUtils: Adds details from the project's remote URL to the given POM.
addRemoteDetails(MavenPom, String) - Method in interface net.minecraftforge.gradleutils.PomUtils: Adds details from the given remote URL to the given POM.
Apache2_0 - Static variable in interface net.minecraftforge.gradleutils.PomUtils.Licenses
apply(T) - Method in class net.minecraftforge.gradleutils.shared.EnhancedPlugin: This method is used by Gradle to apply this plugin.
argOnlyIf(String, Provider<Boolean>) - Method in class net.minecraftforge.gradleutils.shared.ToolExecBase: Adds the given argument if and only if the given boolean property is present and true.
argOnlyIf(String, Spec<? super ToolExecBase<?>>) - Method in class net.minecraftforge.gradleutils.shared.ToolExecBase: Adds the given argument if and only if the given spec, using this task, is satisfied.
args(String, Iterable<? extends File>) - Method in class net.minecraftforge.gradleutils.shared.ToolExecBase: Adds each file to the arguments preceded by the given argument.
args(String, FileSystemLocationProperty<? extends FileSystemLocation>) - Method in class net.minecraftforge.gradleutils.shared.ToolExecBase: Adds the given argument followed by the given file location to the arguments.
args(String, Provider<?>) - Method in class net.minecraftforge.gradleutils.shared.ToolExecBase: Adds the given argument followed by the given object (may be a file location) to the arguments.

C

call() - Method in class net.minecraftforge.gradleutils.shared.Lazy
callable(Object, Callable<? extends R>) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Creates a closure backed by the given callable.
callable(Callable<? extends R>) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Creates a closure backed by the given callable.
closure - Variable in class net.minecraftforge.gradleutils.shared.Lazy: The closure that will provide the value for this lazy.
Closures - Class in net.minecraftforge.gradleutils.shared: This class contains helper methods for creating closures in Java code.
consumer(Object, Consumer<? super T>) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Creates a closure backed by the given consumer.
consumer(Consumer<? super T>) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Creates a closure backed by the given consumer.
copy() - Method in class net.minecraftforge.gradleutils.shared.Lazy.Actionable: Copies this actionable lazy.

D

defaultToolDir - Variable in class net.minecraftforge.gradleutils.shared.ToolExecBase: The default tool directory (usage is not required).
developers - Static variable in interface net.minecraftforge.gradleutils.PomUtils: Contains several developers within the MinecraftForge organization to reduce needing to manually write them out in each project they contribute to.

E

empty() - Static method in class net.minecraftforge.gradleutils.shared.Closures: Creates an empty closure.
empty(Object) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Creates an empty closure.
EnhancedPlugin<T> - Class in net.minecraftforge.gradleutils.shared: The enhanced plugin contains several helper members to assist in making Gradle plugins as clean as possible without needing to duplicate code across projects.
EnhancedPlugin(String, String) - Constructor for class net.minecraftforge.gradleutils.shared.EnhancedPlugin: This constructor must be called by all subclasses using a public constructor annotated with Inject.
EnhancedProblems - Class in net.minecraftforge.gradleutils.shared: The enhanced problems contain several base helper members to help reduce duplicate code between Gradle plugins.
EnhancedProblems(String, String) - Constructor for class net.minecraftforge.gradleutils.shared.EnhancedProblems: Creates a new enhanced problems instance using the given name and display name.
EnhancedTask - Interface in net.minecraftforge.gradleutils.shared: The enhanced task contains a handful of helper methods to make working with the enhanced plugin and caches easier.
ensureAfterEvaluate(Project, Closure<?>) - Static method in class net.minecraftforge.gradleutils.shared.SharedUtil: Runs the given closure using Project.afterEvaluate(Action).
ensureAfterEvaluate(Project, Action<? super Project>) - Static method in class net.minecraftforge.gradleutils.shared.SharedUtil: Runs the given action using Project.afterEvaluate(Action).
ensureFileLocation() - Method in class net.minecraftforge.gradleutils.shared.EnhancedProblems: A utility method to ensure that a FileSystemLocation Provider has (its parent) directory created.
exec() - Method in class net.minecraftforge.gradleutils.shared.ToolExecBase

F

forgeMaven - Static variable in interface net.minecraftforge.gradleutils.GradleUtilsExtension: A closure for the Forge maven to be passed into RepositoryHandler.maven(Closure).
forgeReleaseMaven - Static variable in interface net.minecraftforge.gradleutils.GradleUtilsExtension: A closure for the Forge releases maven to be passed into RepositoryHandler.maven(Closure).
function(Object, Function<? super T, ? extends R>) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Creates a closure backed by the given function.
function(Function<? super T, ? extends R>) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Creates a closure backed by the given function.

G

GenerateActionsWorkflow - Interface in net.minecraftforge.gradleutils: This task generates the GitHub Actions workflow file for the project.
get() - Method in class net.minecraftforge.gradleutils.shared.Lazy.Actionable
get() - Method in class net.minecraftforge.gradleutils.shared.Lazy: Gets (and resolves if absent) this lazy value.
get(Directory, ProviderFactory) - Method in interface net.minecraftforge.gradleutils.shared.Tool: Gets this tool and returns a provider for the downloaded/cached file.
get(Provider<? extends Directory>, ProviderFactory) - Method in interface net.minecraftforge.gradleutils.shared.Tool: Gets this tool and returns a provider for the downloaded/cached file.
getBranch() - Method in interface net.minecraftforge.gradleutils.GenerateActionsWorkflow: The branch name to use in the workflow file.
getDefaultOutputDirectory() - Method in interface net.minecraftforge.gradleutils.shared.EnhancedTask: The default output directory to use for this task if it outputs a directory.
getDefaultOutputFile() - Method in interface net.minecraftforge.gradleutils.shared.EnhancedTask: The default output file to use for this task if it outputs a file.
getDefaultOutputFile(String) - Method in interface net.minecraftforge.gradleutils.shared.EnhancedTask: The default output file to use for this task if it outputs a file.
getGradleJavaVersion() - Method in interface net.minecraftforge.gradleutils.GenerateActionsWorkflow: The Java version to invoke Gradle with.
getJavadocLink(String, String, String) - Method in class net.minecraftforge.gradleutils.services.GradleAPIJavadocLinkProvider
getJavaVersion() - Method in interface net.minecraftforge.gradleutils.shared.Tool: The Java version this tool was built with.
getLicenses() - Method in interface net.minecraftforge.gradleutils.PomUtils: Allows accessing licenses from buildscripts using gradleutils.pom.licenses.
getLocalPath() - Method in interface net.minecraftforge.gradleutils.GenerateActionsWorkflow: The local path from the root project to the current project to use in the workflow file.
getMainClass() - Method in interface net.minecraftforge.gradleutils.shared.Tool: The main class to use when executing this tool.
getName() - Method in interface net.minecraftforge.gradleutils.shared.Tool: The name for this tool.
getObjects() - Method in class net.minecraftforge.gradleutils.shared.EnhancedPlugin
getOutputFile() - Method in interface net.minecraftforge.gradleutils.GenerateActionsWorkflow: The output file for this task.
getPaths() - Method in interface net.minecraftforge.gradleutils.GenerateActionsWorkflow: The paths to pass into the workflow file.
getPom() - Method in interface net.minecraftforge.gradleutils.GradleUtilsExtensionForProject: Utilities for working with a MavenPom for publishing artifacts.
getProblemGroup() - Method in class net.minecraftforge.gradleutils.shared.EnhancedProblems: Gets the problem group used by this problems instance.
getProblems() - Method in class net.minecraftforge.gradleutils.shared.EnhancedProblems
getProblems() - Method in class net.minecraftforge.gradleutils.shared.ToolExecBase: The enhanced problems instance to use for this task.
getProjectLayout() - Method in class net.minecraftforge.gradleutils.shared.ToolExecBase
getProjectName() - Method in interface net.minecraftforge.gradleutils.GenerateActionsWorkflow: The project name to use in the workflow file.
getProviders() - Method in class net.minecraftforge.gradleutils.shared.EnhancedPlugin
getProviders() - Method in class net.minecraftforge.gradleutils.shared.EnhancedProblems
getPublishingForgeMaven() - Method in interface net.minecraftforge.gradleutils.GradleUtilsExtensionForProject: Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.
getPublishingForgeMaven(String) - Method in interface net.minecraftforge.gradleutils.GradleUtilsExtensionForProject: Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.
getPublishingForgeMaven(String, File) - Method in interface net.minecraftforge.gradleutils.GradleUtilsExtensionForProject: Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.
getPublishingForgeMaven(String, File, File) - Method in interface net.minecraftforge.gradleutils.GradleUtilsExtensionForProject: Get a configuring closure to be passed into RepositoryHandler.maven(Closure) in a publishing block.
getReporter() - Method in class net.minecraftforge.gradleutils.shared.EnhancedProblems
getSharedActionsBranch() - Method in interface net.minecraftforge.gradleutils.GenerateActionsWorkflow: The Shared Actions branch to use with this workflow.
getTool(Tool) - Method in class net.minecraftforge.gradleutils.shared.EnhancedPlugin: Gets a provider to the file for a Tool to be used.
getTool(Tool) - Method in interface net.minecraftforge.gradleutils.shared.EnhancedTask
globalCaches() - Method in class net.minecraftforge.gradleutils.shared.EnhancedPlugin: Gets the global caches to be used for this plugin.
globalCaches() - Method in interface net.minecraftforge.gradleutils.shared.EnhancedTask
GradleAPIJavadocLinkProvider - Class in net.minecraftforge.gradleutils.services: Service to allow Nokee and Remal's redistributions of the Gradle API to link to Gradle's JavaDocs website.
GradleAPIJavadocLinkProvider() - Constructor for class net.minecraftforge.gradleutils.services.GradleAPIJavadocLinkProvider: Invoked by the ServiceLoader.
GradleUtilsExtension - Interface in net.minecraftforge.gradleutils: Contains various utilities for working with Gradle scripts.
GradleUtilsExtensionForProject - Interface in net.minecraftforge.gradleutils: The GradleUtils extension for projects, which include additional utilities that are only available for them.

H

HELP_MESSAGE - Static variable in class net.minecraftforge.gradleutils.shared.EnhancedProblems: The common message to send in ProblemSpec.solution(String) when reporting problems.

I

id(String, String) - Method in class net.minecraftforge.gradleutils.shared.EnhancedProblems: Creates a problem ID to be used when reporting problems.
ifPresent(Action<? super T>) - Method in class net.minecraftforge.gradleutils.shared.Lazy: Runs the given action on this lazy value if it is present.
illegalPluginTarget(Exception, Class<?>, Class<?>...) - Method in class net.minecraftforge.gradleutils.shared.EnhancedProblems: Reports an illegal plugin target.
illegalPluginTarget(Exception, String) - Method in class net.minecraftforge.gradleutils.shared.EnhancedProblems: Reports an illegal plugin target.
invoke(Closure) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Invokes a given closure with no parameters.
invoke(Closure, Object...) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Invokes a given closure with the given object as the delegate type and parameter.
isPresent() - Method in class net.minecraftforge.gradleutils.shared.Lazy.Actionable: Checks if this actionable lazy is present.
isPresent() - Method in class net.minecraftforge.gradleutils.shared.Lazy: Checks if this lazy value is present.

L

launcherFor(JavaPluginExtension, JavaToolchainService, int) - Static method in class net.minecraftforge.gradleutils.shared.SharedUtil: Gets the Java launcher that can compile or run the given version.
launcherFor(JavaPluginExtension, JavaToolchainService, JavaLanguageVersion) - Static method in class net.minecraftforge.gradleutils.shared.SharedUtil: Gets the Java launcher that can compile or run the given version.
launcherFor(Project, int) - Static method in class net.minecraftforge.gradleutils.shared.SharedUtil: Gets the Java launcher that can compile or run the given version.
launcherFor(Project, JavaLanguageVersion) - Static method in class net.minecraftforge.gradleutils.shared.SharedUtil: Gets the Java launcher that can compile or run the given version.
launcherFor(Provider<? extends JavaPluginExtension>, Provider<? extends JavaToolchainService>, int) - Static method in class net.minecraftforge.gradleutils.shared.SharedUtil: Gets the Java launcher that can compile or run the given version.
launcherFor(Provider<? extends JavaPluginExtension>, Provider<? extends JavaToolchainService>, JavaLanguageVersion) - Static method in class net.minecraftforge.gradleutils.shared.SharedUtil: Gets the Java launcher that can compile or run the given version.
launcherForStrictly(Project, int) - Static method in class net.minecraftforge.gradleutils.shared.SharedUtil: Gets the Java launcher strictly for the given version, even if the currently running Java toolchain is higher than it.
launcherForStrictly(Project, JavaLanguageVersion) - Static method in class net.minecraftforge.gradleutils.shared.SharedUtil: Gets the Java launcher strictly for the given version, even if the currently running Java toolchain is higher than it.
launcherForStrictly(Provider<? extends JavaToolchainService>, int) - Static method in class net.minecraftforge.gradleutils.shared.SharedUtil: Gets the Java launcher strictly for the given version, even if the currently running Java toolchain is higher than it.
launcherForStrictly(Provider<? extends JavaToolchainService>, JavaLanguageVersion) - Static method in class net.minecraftforge.gradleutils.shared.SharedUtil: Gets the Java launcher strictly for the given version, even if the currently running Java toolchain is higher than it.
launcherForStrictly(JavaToolchainService, int) - Static method in class net.minecraftforge.gradleutils.shared.SharedUtil: Gets the Java launcher strictly for the given version, even if the currently running Java toolchain is higher than it.
launcherForStrictly(JavaToolchainService, JavaLanguageVersion) - Static method in class net.minecraftforge.gradleutils.shared.SharedUtil: Gets the Java launcher strictly for the given version, even if the currently running Java toolchain is higher than it.
Lazy<T> - Class in net.minecraftforge.gradleutils.shared: This is a simple implementation of a Lazy value, primarily aimed for use in Java code.
Lazy.Actionable<T> - Class in net.minecraftforge.gradleutils.shared: Represents a lazily computed value with the ability to optionally work with it using Lazy.ifPresent(Action) and safely mutate it using Lazy.Actionable.map(Action).
LGPLv2_1 - Static variable in interface net.minecraftforge.gradleutils.PomUtils.Licenses
LGPLv3 - Static variable in interface net.minecraftforge.gradleutils.PomUtils.Licenses
localCaches() - Method in class net.minecraftforge.gradleutils.shared.EnhancedPlugin: Gets the local caches to be used for this plugin.
localCaches() - Method in interface net.minecraftforge.gradleutils.shared.EnhancedTask

M

map(Action<? super T>) - Method in class net.minecraftforge.gradleutils.shared.Lazy.Actionable: Queues the given action to run on the value once it has been computed.
minecraftLibsMaven - Static variable in interface net.minecraftforge.gradleutils.GradleUtilsExtension: A closure for the Minecraft libraries maven to be passed into RepositoryHandler.maven(Closure).
MIT - Static variable in interface net.minecraftforge.gradleutils.PomUtils.Licenses

N

NAME - Static variable in interface net.minecraftforge.gradleutils.GenerateActionsWorkflow: The name for this task.
NAME - Static variable in interface net.minecraftforge.gradleutils.GradleUtilsExtension: The name for this extension.
net.minecraftforge.gradleutils - package net.minecraftforge.gradleutils: GradleUtils is a convention plugin that is used by almost all of Forge's projects.
net.minecraftforge.gradleutils.services - package net.minecraftforge.gradleutils.services: This package contains services that are loaded into the Gradle classpath along with this plugin.
net.minecraftforge.gradleutils.shared - package net.minecraftforge.gradleutils.shared: This package contains common code that is shared between MinecraftForge's Gradle plugins.

O

of(String, String, String, int) - Static method in interface net.minecraftforge.gradleutils.shared.Tool: Creates a new tool with the given information.
of(String, String, String, int, String) - Static method in interface net.minecraftforge.gradleutils.shared.Tool: Creates a new tool with the given information.

P

pluginNotYetApplied(Exception) - Method in class net.minecraftforge.gradleutils.shared.EnhancedProblems: Reports an illegal access of a plugin before it has been applied.
pluginType() - Method in interface net.minecraftforge.gradleutils.shared.EnhancedTask: The enhanced plugin type for this task.
PomUtils - Interface in net.minecraftforge.gradleutils: Contains utilities to make working with POMs more ergonomic.
PomUtils.Licenses - Interface in net.minecraftforge.gradleutils: Contains several licenses used by MinecraftForge to reduce needing to manually write them out in each project that uses one.

R

reportToolExecEagerArgs(Task) - Method in class net.minecraftforge.gradleutils.shared.EnhancedProblems: Reports an implementation of ToolExecBase that adds arguments without using addArguments()
reportToolExecNotEnhanced(Class<?>) - Method in class net.minecraftforge.gradleutils.shared.EnhancedProblems: Reports an implementation of EnhancedTask that does not implement EnhancedTask.pluginType()
reportToolExecNotEnhanced(Task) - Method in class net.minecraftforge.gradleutils.shared.EnhancedProblems: Reports an implementation of ToolExecBase that is not enhanced with EnhancedTask.
runnable(Object, Runnable) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Creates a closure backed by the given runnable.
runnable(Runnable) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Creates a closure backed by the given runnable.

S

setup(T) - Method in class net.minecraftforge.gradleutils.shared.EnhancedPlugin: Called when this plugin is applied to do setup work.
SharedUtil - Class in net.minecraftforge.gradleutils.shared: Shared utilities for Gradle plugins.
SharedUtil() - Constructor for class net.minecraftforge.gradleutils.shared.SharedUtil: Empty constructor.
simple(Closure<T>) - Static method in class net.minecraftforge.gradleutils.shared.Lazy: Creates a simple lazy of the given closure.
simple(Callable<T>) - Static method in class net.minecraftforge.gradleutils.shared.Lazy: Creates a simple lazy of the given callable.
supplier(Object, Supplier<? extends R>) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Creates a closure backed by the given supplier.
supplier(Supplier<? extends R>) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Creates a closure backed by the given supplier.

T

test(String) - Method in class net.minecraftforge.gradleutils.shared.EnhancedProblems: Checks if the given property exists and equals true.
toAction(Closure<?>) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Creates an action backed by the given closure.
toLog(Action<? super String>) - Static method in class net.minecraftforge.gradleutils.shared.SharedUtil: Creates an output stream that logs to the given action.
Tool - Interface in net.minecraftforge.gradleutils.shared: Tools are definitions of Java libraries (may or may not be executable) that are managed by Gradle using a ValueSource.
ToolExecBase<P> - Class in net.minecraftforge.gradleutils.shared: This tool execution task is a template on top of JavaExec to make executing tools much easier and more consistent between plugins.
ToolExecBase(Class<P>, Tool) - Constructor for class net.minecraftforge.gradleutils.shared.ToolExecBase: Creates a new task instance using the given types and tool information.
toString(Dependency) - Static method in class net.minecraftforge.gradleutils.shared.SharedUtil: Converts a given dependency to string.
toString(ModuleVersionSelector) - Static method in class net.minecraftforge.gradleutils.shared.SharedUtil: Converts a given module to string.

U

unaryOperator(Object, UnaryOperator<? extends R>) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Creates a closure backed by the given unary operator.
unaryOperator(UnaryOperator<? extends R>) - Static method in class net.minecraftforge.gradleutils.shared.Closures: Creates a closure backed by the given unary operator.

V

value - Variable in class net.minecraftforge.gradleutils.shared.Lazy: The value of this lazy, will be null if it has not yet been computed with Lazy.get().

A C D E F G H I L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values