Class SharedUtil

java.lang.Object
net.minecraftforge.gradleutils.shared.SharedUtil
public abstract class SharedUtil extends Object
Shared utilities for Gradle plugins.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    SharedUtil()
    Empty constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    ensureAfterEvaluate(org.gradle.api.Project project, Closure<?> closure)
    Runs the given closure using Project.afterEvaluate(Action).
    static void
    ensureAfterEvaluate(org.gradle.api.Project project, org.gradle.api.Action<? super org.gradle.api.Project> action)
    Runs the given action using Project.afterEvaluate(Action).
    static org.gradle.api.provider.Provider<org.gradle.jvm.toolchain.JavaLauncher>
    launcherFor(org.gradle.api.plugins.ExtensionAware object, int version)
    Gets the Java launcher that can compile or run the given version.
    static org.gradle.api.provider.Provider<org.gradle.jvm.toolchain.JavaLauncher>
    launcherFor(org.gradle.api.plugins.ExtensionAware object, org.gradle.jvm.toolchain.JavaLanguageVersion version)
    Gets the Java launcher that can compile or run the given version.
    static org.gradle.api.provider.Provider<org.gradle.jvm.toolchain.JavaLauncher>
    launcherFor(org.gradle.api.plugins.JavaPluginExtension java, org.gradle.jvm.toolchain.JavaToolchainService javaToolchains, int version)
    Gets the Java launcher that can compile or run the given version.
    static org.gradle.api.provider.Provider<org.gradle.jvm.toolchain.JavaLauncher>
    launcherFor(org.gradle.api.plugins.JavaPluginExtension java, org.gradle.jvm.toolchain.JavaToolchainService javaToolchains, org.gradle.jvm.toolchain.JavaLanguageVersion version)
    Gets the Java launcher that can compile or run the given version.
    static org.gradle.api.provider.Provider<org.gradle.jvm.toolchain.JavaLauncher>
    launcherForStrictly(org.gradle.api.plugins.ExtensionAware object, int version)
    Gets the Java launcher strictly for the given version, even if the currently running Java toolchain is higher than it.
    static org.gradle.api.provider.Provider<org.gradle.jvm.toolchain.JavaLauncher>
    launcherForStrictly(org.gradle.api.plugins.ExtensionAware object, org.gradle.jvm.toolchain.JavaLanguageVersion version)
    Gets the Java launcher strictly for the given version, even if the currently running Java toolchain is higher than it.
    static org.gradle.api.provider.Provider<org.gradle.jvm.toolchain.JavaLauncher>
    launcherForStrictly(org.gradle.jvm.toolchain.JavaToolchainService javaToolchains, int version)
    Gets the Java launcher strictly for the given version, even if the currently running Java toolchain is higher than it.
    static org.gradle.api.provider.Provider<org.gradle.jvm.toolchain.JavaLauncher>
    launcherForStrictly(org.gradle.jvm.toolchain.JavaToolchainService javaToolchains, org.gradle.jvm.toolchain.JavaLanguageVersion version)
    Gets the Java launcher strictly for the given version, even if the currently running Java toolchain is higher than it.
    static OutputStream
    toLog(org.gradle.api.Action<? super String> logger)
    Creates an output stream that logs to the given action.
    static String
    toString(org.gradle.api.artifacts.Dependency dependency)
    Converts a given dependency to string.
    static String
    toString(org.gradle.api.artifacts.ModuleVersionSelector module)
    Converts a given module to string.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • 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 org.gradle.api.provider.Provider<org.gradle.jvm.toolchain.JavaLauncher> launcherFor(org.gradle.api.plugins.JavaPluginExtension java, org.gradle.jvm.toolchain.JavaToolchainService javaToolchains, int version)

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

      If the currently running Java toolchain is able to compile and run the given version, it will be used instead.

      Parameters:
      java - The Java plugin extension of the currently-used toolchain
      javaToolchains - The Java toolchain service to get the Java launcher from
      version - The version of Java required
      Returns:
      A provider for the Java launcher

    • launcherFor

      public static org.gradle.api.provider.Provider<org.gradle.jvm.toolchain.JavaLauncher> launcherFor(org.gradle.api.plugins.JavaPluginExtension java, org.gradle.jvm.toolchain.JavaToolchainService javaToolchains, org.gradle.jvm.toolchain.JavaLanguageVersion version)

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

      If the currently running Java toolchain is able to compile and run the given version, it will be used instead.

      Parameters:
      java - The Java plugin extension of the currently-used toolchain
      javaToolchains - The Java toolchain service to get the Java launcher from
      version - The version of Java required
      Returns:
      A provider for the Java launcher

    • launcherFor

      public static org.gradle.api.provider.Provider<org.gradle.jvm.toolchain.JavaLauncher> launcherFor(org.gradle.api.plugins.ExtensionAware object, int version)

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

      If the currently running Java toolchain is able to compile and run the given version, it will be used instead.

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

    • launcherFor

      public static org.gradle.api.provider.Provider<org.gradle.jvm.toolchain.JavaLauncher> launcherFor(org.gradle.api.plugins.ExtensionAware object, org.gradle.jvm.toolchain.JavaLanguageVersion version)

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

      If the currently running Java toolchain is able to compile and run the given version, it will be used instead.

      Parameters:
      object - 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 org.gradle.api.provider.Provider<org.gradle.jvm.toolchain.JavaLauncher> launcherForStrictly(org.gradle.jvm.toolchain.JavaToolchainService javaToolchains, int version)
      Gets the Java launcher strictly for the given version, even if the currently running Java toolchain is higher than it.
      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 org.gradle.api.provider.Provider<org.gradle.jvm.toolchain.JavaLauncher> launcherForStrictly(org.gradle.jvm.toolchain.JavaToolchainService javaToolchains, org.gradle.jvm.toolchain.JavaLanguageVersion version)
      Gets the Java launcher strictly for the given version, even if the currently running Java toolchain is higher than it.
      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 org.gradle.api.provider.Provider<org.gradle.jvm.toolchain.JavaLauncher> launcherForStrictly(org.gradle.api.plugins.ExtensionAware object, int version)
      Gets the Java launcher strictly for the given version, even if the currently running Java toolchain is higher than it.
      Parameters:
      object - 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 org.gradle.api.provider.Provider<org.gradle.jvm.toolchain.JavaLauncher> launcherForStrictly(org.gradle.api.plugins.ExtensionAware object, org.gradle.jvm.toolchain.JavaLanguageVersion version)
      Gets the Java launcher strictly for the given version, even if the currently running Java toolchain is higher than it.
      Parameters:
      object - The extension-aware object to get the Java extensions from
      version - The version of Java required
      Returns:
      A provider for the Java launcher

    • ensureAfterEvaluate

      public static void ensureAfterEvaluate(org.gradle.api.Project project, @DelegatesTo(value=org.gradle.api.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(org.gradle.api.Project project, org.gradle.api.Action<? super org.gradle.api.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

    • toLog

      public static OutputStream toLog(org.gradle.api.Action<? 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(org.gradle.api.artifacts.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(org.gradle.api.artifacts.Dependency dependency)
      Converts a given dependency to string. Use this instead of Object.toString().
      Parameters:
      dependency - The dependency
      Returns:
      The string representation