Package dev.nokee.commons.names

Class JvmNames

java.lang.Object
dev.nokee.commons.names.JvmNames
public class JvmNames extends Object
Task and configuration names for java, java-library, groovy, and Kotlin plugins.

  • Constructor Details

    • JvmNames

      public JvmNames()

  • Method Details

    • compileOnlyApiConfigurationName

      public static String compileOnlyApiConfigurationName(SourceSet sourceSet)
      Returns the qualifyingNameCompileOnlyApi configuration name. For example:
      • compileOnlyApi

      Note 1: only exists for java-library project.

      Note 2: From Gradle 6.7 and later, use SourceSet#getCompileOnlyApiConfigurationName().

      Parameters:
      sourceSet - the source set object that qualify the configuration name, must not be null
      Returns:
      a configuration name

    • groovydocJarTaskName

      public static String groovydocJarTaskName(SourceSet sourceSet)
      Returns the qualifyingNameGroovydocJar task name. For example:
      • groovydocJar
      • testGroovydocJar

      Note: does not exist on groovy project, for convenience only.

      Parameters:
      sourceSet - the source set object that qualify the task name, must not be null
      Returns:
      a task name

    • groovydocTaskName

      public static String groovydocTaskName(SourceSet sourceSet)
      Returns the qualifyingNameGroovydoc task name. For example:
      • groovydoc
      • testGroovydoc

      Note: exists only on groovy project.

      Parameters:
      sourceSet - the source set object that qualify the task name, must not be null
      Returns:
      a task name

    • groovydocElementsConfigurationName

      public static String groovydocElementsConfigurationName(SourceSet sourceSet)
      Returns the qualifyingNameGroovydocElements configuration name. For example:
      • groovydocElements
      • testGroovydocElements

      Note: does not exist on groovy project, for convenience only and symmetry with SourceSet.getJavadocElementsConfigurationName()

      Parameters:
      sourceSet - the source set object that qualify the configuration name, must not be null
      Returns:
      a configuration name

    • pluginUnderTestMetadataTaskName

      public static String pluginUnderTestMetadataTaskName()
      Returns the pluginUnderTestMetadata task name.

      Note: exist only for java-gradle-plugin project.

      Returns:
      a task name

    • compileKotlinTaskName

      public static String compileKotlinTaskName(SourceSet sourceSet)
      Returns the compileQualifyingNameKotlin task name. For example:
      • compileKotlin
      • compileTestKotlin

      Note: exist only for Kotlin project, for convenience only.

      Returns:
      a task name

    • compileGroovyTaskName

      public static String compileGroovyTaskName(SourceSet sourceSet)
      Returns the compileQualifyingNameGroovy task name. For example:
      • compileGroovy
      • compileTestGroovy

      Note: exist only for groovy project, for convenience only.

      Returns:
      a task name