Package name.jurgenei.gradle.archi

Class ArchiTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
name.jurgenei.gradle.archi.ArchiTask
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="Archi execution depends on external runtime state and environment") public abstract class ArchiTask extends org.gradle.api.DefaultTask
Task that runs Archi model export/transformation via configured backend.

  • 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
    ArchiTask()
    Creates task with default conventions.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    arg(String value)
    Appends a single backend argument.
    void
    env(String name, Object value)
    Adds/overrides one backend environment variable.
    void
    excel(Object value)
    Sets Excel export argument value.
    abstract org.gradle.api.provider.ListProperty<String>
    getArgs()
    Additional backend arguments.
    abstract org.gradle.api.file.DirectoryProperty
    getBuildDir()
    Build directory used by the backend at execution time.
    abstract org.gradle.api.provider.MapProperty<String,String>
    getEnvs()
    Additional backend environment variables.
    abstract org.gradle.api.provider.Property<String>
    getExcel()
    Optional Excel export target.
    abstract org.gradle.api.provider.Property<File>
    getInputFile()
    Input model file.
    abstract org.gradle.api.provider.Property<File>
    getOutputFile()
    Output file produced by Archi processing.
    abstract org.gradle.api.file.DirectoryProperty
    getProjectDir()
    Project directory used by the backend at execution time.
    abstract org.gradle.api.provider.Property<String>
    getScript()
    Optional script path passed to Archi.
    abstract org.gradle.api.provider.Property<Boolean>
    getStub()
    Chooses stub backend when true, CLI backend when false.
    void
    input(Object value)
    Sets input model file.
    void
    output(Object value)
    Sets output file.
    void
    runArchi()
    Executes Archi processing using configured task inputs.
    void
    script(Object value)
    Sets script argument value.
    void
    stub(boolean value)
    Sets stub backend usage.

    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

    • ArchiTask

      public ArchiTask()
      Creates task with default conventions.

  • Method Details

    • getInputFile

      @Optional @InputFile @PathSensitive(RELATIVE) public abstract org.gradle.api.provider.Property<File> getInputFile()
      Input model file.
      Returns:
      input file property.

    • getOutputFile

      @Optional @OutputFile public abstract org.gradle.api.provider.Property<File> getOutputFile()
      Output file produced by Archi processing.
      Returns:
      output file property.

    • getStub

      @Input public abstract org.gradle.api.provider.Property<Boolean> getStub()
      Chooses stub backend when true, CLI backend when false.
      Returns:
      stub toggle property.

    • getScript

      @Input public abstract org.gradle.api.provider.Property<String> getScript()
      Optional script path passed to Archi.
      Returns:
      script property.

    • getExcel

      @Input public abstract org.gradle.api.provider.Property<String> getExcel()
      Optional Excel export target.
      Returns:
      excel export property.

    • getArgs

      @Input public abstract org.gradle.api.provider.ListProperty<String> getArgs()
      Additional backend arguments.
      Returns:
      argument list property.

    • getEnvs

      @Input public abstract org.gradle.api.provider.MapProperty<String,String> getEnvs()
      Additional backend environment variables.
      Returns:
      environment map property.

    • getProjectDir

      @Internal public abstract org.gradle.api.file.DirectoryProperty getProjectDir()
      Project directory used by the backend at execution time.
      Returns:
      project directory property.

    • getBuildDir

      @Internal public abstract org.gradle.api.file.DirectoryProperty getBuildDir()
      Build directory used by the backend at execution time.
      Returns:
      build directory property.

    • input

      public void input(Object value)
      Sets input model file.
      Parameters:
      value - file path/object resolvable by Gradle.

    • output

      public void output(Object value)
      Sets output file.
      Parameters:
      value - file path/object resolvable by Gradle.

    • stub

      public void stub(boolean value)
      Sets stub backend usage.
      Parameters:
      value - true to use stub backend.

    • script

      public void script(Object value)
      Sets script argument value.
      Parameters:
      value - script path/value.

    • excel

      public void excel(Object value)
      Sets Excel export argument value.
      Parameters:
      value - Excel target value.

    • arg

      public void arg(String value)
      Appends a single backend argument.
      Parameters:
      value - argument value.

    • env

      public void env(String name, Object value)
      Adds/overrides one backend environment variable.
      Parameters:
      name - environment variable name.
      value - environment variable value.

    • runArchi

      public void runArchi()
      Executes Archi processing using configured task inputs.