Package com.arc_e_tect.gradle.trackerlens

Class InitTrackerLensTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
com.arc_e_tect.gradle.trackerlens.InitTrackerLensTask
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="Refuses to overwrite an existing lens file; a cache restore would bypass that safety check") public abstract class InitTrackerLensTask extends org.gradle.api.DefaultTask
Generates a complete, heavily-commented boilerplate lens CSS file to start a new lens from, covering every selector ContractRule governs (see DASHBOARD-THEMING.adoc) with inline comments explaining what each one is for and clearly-fake placeholder colors to replace.

Writes to the fixed resource path a lens must live under to be discovered (src/main/resources/META-INF/arc-e-tect/tracker-lens/lenses/my-lens.css by default), so the file this task generates is immediately a working (if unstyled) lens - see LENS_TUTORIAL.adoc for the full walkthrough from here to a published style pack, or bootstrapTrackerLensProject to generate the surrounding project as well.

  • 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
    InitTrackerLensTask()
    Creates a new task instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.file.RegularFileProperty
    getLensFile()
    Where the boilerplate lens CSS file is written.
    void
    init()
    Generates the boilerplate lens file, refusing to overwrite one that already exists.

    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

    • InitTrackerLensTask

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

  • Method Details

    • getLensFile

      @OutputFile public abstract org.gradle.api.file.RegularFileProperty getLensFile()
      Where the boilerplate lens CSS file is written.
      Returns:
      mutable file property for the generated lens file

    • init

      public void init()
      Generates the boilerplate lens file, refusing to overwrite one that already exists.