Class SharedUtil

java.lang.Object
net.minecraftforge.gradleutils.shared.SharedUtil
public abstract class SharedUtil extends Object
Shared utilities for Gradle plugins.
Implementation Note:
Consumers should make their own Util class and extend this one with it to inherit all static methods.

  • Field Details

    • LAUNCHER_EXECUTABLE

      public static final Transformer<String, JavaLauncher> LAUNCHER_EXECUTABLE
      Transformer to map a Java launcher to its executable path. Use to store in properties since JavaLauncher cannot be serialized.

  • Constructor Details

    • SharedUtil

      protected SharedUtil()
      Empty constructor. This class should only be extended to make referencing these static methods easier.

  • Method Details

    • launcherFor

      public static Provider<JavaLauncher> launcherFor(Project project, int version)

      Gets the Java launcher that can compile or run the given version.

      If the currently available Java toolchain is able to compile and run the given version, it will be used instead. The toolchain is first queried from the project's JavaPluginExtension.getToolchain(). If the toolchain is not set or does not apply the java plugin, JavaLanguageVersion.current() will be used instead.

      Parameters:
      project - The project to get the Java extensions from
      version - The version of Java required
      Returns:
      A provider for the Java launcher

    • launcherFor

      public static Provider<JavaLauncher> launcherFor(Project project, JavaLanguageVersion version)

      Gets the Java launcher that can compile or run the given version.

      If the currently available Java toolchain is able to compile and run the given version, it will be used instead. The toolchain is first queried from the project's JavaPluginExtension.getToolchain(). If the toolchain is not set or does not apply the java plugin, JavaLanguageVersion.current() will be used instead.

      Parameters:
      project - The project to get the Java extensions from
      version - The version of Java required
      Returns:
      A provider for the Java launcher

    • launcherForStrictly

      public static Provider<JavaLauncher> launcherForStrictly(Project project, int version)
      Gets the Java launcher for the given version, even if the currently running Java toolchain is higher.
      Parameters:
      project - The extension-aware object to get the Java extensions from
      version - The version of Java required
      Returns:
      A provider for the Java launcher

    • launcherForStrictly

      public static Provider<JavaLauncher> launcherForStrictly(Project project, JavaLanguageVersion version)
      Gets the Java launcher for the given version, even if the currently running Java toolchain is higher.
      Parameters:
      project - The extension-aware object to get the Java extensions from
      version - The version of Java required
      Returns:
      A provider for the Java launcher

    • launcherForStrictly

      public static Provider<JavaLauncher> launcherForStrictly(JavaToolchainService javaToolchains, int version)
      Gets the Java launcher for the given version, even if the currently running Java toolchain is higher.
      Parameters:
      javaToolchains - The Java toolchain service to get the Java launcher from
      version - The version of Java required
      Returns:
      A provider for the Java launcher

    • launcherForStrictly

      public static Provider<JavaLauncher> launcherForStrictly(JavaToolchainService javaToolchains, JavaLanguageVersion version)
      Gets the Java launcher for the given version, even if the currently running Java toolchain is higher.
      Parameters:
      javaToolchains - The Java toolchain service to get the Java launcher from
      version - The version of Java required
      Returns:
      A provider for the Java launcher

    • ensureAfterEvaluate

      public static void ensureAfterEvaluate(Project project, @DelegatesTo(value=Project.class,strategy=1) Closure<?> closure)
      Runs the given closure using Project.afterEvaluate(Action). If the project is already executed, the closure will be called instantly.
      Parameters:
      project - The project to run the closure on
      closure - The closure to execute

    • ensureAfterEvaluate

      public static void ensureAfterEvaluate(Project project, Action<? super Project> action)
      Runs the given action using Project.afterEvaluate(Action). If the project is already executed, the action will be executed instantly.
      Parameters:
      project - The project to run the action on
      action - The action to execute

    • runFirst

      public static <T extends TaskProvider<?>> T runFirst(Project project, T task)

      Ensures that a given task is run first in the task graph for the given project.

      This does not break the configuration cache as long as the task is always applied using this.

      Parameters:
      project - The project
      task - The task to run first

    • toLog

      public static PipedOutputStream toLog(Consumer<? super String> logger)
      Creates an output stream that logs to the given action.
      Parameters:
      logger - The logger to log to
      Returns:
      The output stream

    • toString

      public static String toString(ModuleVersionSelector module)
      Converts a given module to string. Use this instead of Object.toString().
      Parameters:
      module - The module
      Returns:
      The string representation

    • toString

      public static String toString(Dependency dependency)
      Converts a given dependency to string. Use this instead of Object.toString().
      Parameters:
      dependency - The dependency
      Returns:
      The string representation

    • finalizeProperty

      public static <P extends Property<?>> Closure<P> finalizeProperty()
      Makes a returning-self closure that finalizes a given property using finalizeProperty(Property).

      This is best used as the method argument for DefaultGroovyMethods.tap(Object, Closure), which allows for in-lining property creation in Groovy code.

      Type Parameters:
      P - The type of property to finalize
      Returns:
      The returning-self closure for finalizing a property

    • finalizeProperty

      @Contract(value="_ -> param1", mutates="param1") public static <P extends Property<?>> P finalizeProperty(P property)

      Finalizes the given property to prevent any additional changes from being made to it.

      This is done by simply calling HasConfigurableValue.disallowChanges() and HasConfigurableValue.finalizeValueOnRead(). These methods do not return the object itself, so this helper method exists to in-line property creation without needing to reference it again just to call these methods.

      Type Parameters:
      P - The type of property to finalize
      Parameters:
      property - The property to finalize
      Returns:
      The property

    • setOptional

      public static <T> void setOptional(Property<T> to, Provider<? extends T> from)
      Conditionally set the given provider's value to the given property's value if the property is present.
      Type Parameters:
      T - The type of property
      Parameters:
      to - The property to apply the new value to
      from - The provider value to apply