Package com.arc_e_tect.gradle.trackerlens

Class ListTrackerLensTemplatesTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
com.arc_e_tect.gradle.trackerlens.ListTrackerLensTemplatesTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
@DisableCachingByDefault(because="Prints the available dashboard templates to the console; produces no outputs") public abstract class ListTrackerLensTemplatesTask extends org.gradle.api.DefaultTask
Lists every Tracker Lens dashboard template available through a lens pack - this plugin's own built-in template and every resolved external lensStyle pack's templates - selectable via trackerLens.templateId, without generating a dashboard.

Scoped to lens packs only, the same way ListTrackerLensStylesTask is scoped to lens packs only: a project's own one-off trackerLens.template file is a different mechanism entirely and never appears here, since it isn't discoverable by id the way a pack's templates are. Resolves the exact same template set as generateTrackerLensDashboard would when templateId is set, via the shared TemplateSetResolver, so this listing can never drift from what templateId can actually select. Needs no tracker to be registered at all - it only touches template resolution.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Named

    org.gradle.api.Named.Namer

  • Field Summary

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    ListTrackerLensTemplatesTask()
    Creates a new task instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.file.ConfigurableFileCollection
    getLensStyleClasspath()
    Classpath entries (directories or jars) resolved from the lensStyle configuration.
    abstract org.gradle.api.provider.Property<String>
    getPreferredLensPack()
    Optional coordinate restricting which single external style pack's templates are offered.
    void
    list()
    Resolves the template set and prints it to the console, grouped by source.

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

    Methods inherited from class org.gradle.api.internal.AbstractTask

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • ListTrackerLensTemplatesTask

      @Inject public ListTrackerLensTemplatesTask()
      Creates a new task instance. Instantiated by Gradle infrastructure.

  • Method Details

    • getLensStyleClasspath

      @Classpath public abstract org.gradle.api.file.ConfigurableFileCollection getLensStyleClasspath()
      Classpath entries (directories or jars) resolved from the lensStyle configuration.
      Returns:
      mutable file collection of external style-pack classpath roots

    • getPreferredLensPack

      @Input @Optional public abstract org.gradle.api.provider.Property<String> getPreferredLensPack()
      Optional coordinate restricting which single external style pack's templates are offered.
      Returns:
      mutable property for the preferred lens pack coordinate

    • list

      public void list()
      Resolves the template set and prints it to the console, grouped by source.