Package io.github.glorrian.cmakegradleplugin

Class CMakeConfigurationTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
io.github.glorrian.cmakegradleplugin.CMakeTask
io.github.glorrian.cmakegradleplugin.CMakeConfigurationTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
public class CMakeConfigurationTask extends CMakeTask
Gradle task for CMake configure stage. Cannot be used outside Gradle.

  • Nested Class Summary

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

    org.gradle.api.Task.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
    CMakeConfigurationTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected List<String>
    buildCommandLine()
    The implementation of this method must contain an assembly of command line arguments for the task
    void
    execute()
    The method that is used as a Task Action
    org.gradle.api.provider.ListProperty<String>
    getArguments()
     
    org.gradle.api.file.DirectoryProperty
    getBuildDirectory()
    Required output property for each task
    org.gradle.api.provider.Property<String>
    getBuildType()
     
    org.gradle.api.provider.Property<String>
    getCMakeExecutable()
    Required input property for each task
    org.gradle.api.provider.Property<String>
    getGenerator()
     
    org.gradle.api.file.DirectoryProperty
    getSourceDirectory()
     
    org.gradle.api.provider.Property<String>
    getToolchain()
     

    Methods inherited from class io.github.glorrian.cmakegradleplugin.CMakeTask

    getExtension, logProviders, setProperties, setTypedFields

    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, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, 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, getConvention, notCompatibleWithConfigurationCache

  • Constructor Details

    • CMakeConfigurationTask

      public CMakeConfigurationTask()

  • Method Details

    • buildCommandLine

      protected List<String> buildCommandLine()
      Description copied from class: CMakeTask
      The implementation of this method must contain an assembly of command line arguments for the task
      Specified by:
      buildCommandLine in class CMakeTask
      Returns:
      The list of arguments to command line

    • execute

      public void execute()
      Description copied from class: CMakeTask
      The method that is used as a Task Action
      Specified by:
      execute in class CMakeTask

    • getBuildDirectory

      @OutputDirectory public org.gradle.api.file.DirectoryProperty getBuildDirectory()
      Description copied from class: CMakeTask
      Required output property for each task
      Specified by:
      getBuildDirectory in class CMakeTask
      Returns:
      DirectoryProperty The directory where CMake is being built

    • getSourceDirectory

      @InputDirectory public org.gradle.api.file.DirectoryProperty getSourceDirectory()

    • getCMakeExecutable

      @InputFile public org.gradle.api.provider.Property<String> getCMakeExecutable()
      Description copied from class: CMakeTask
      Required input property for each task
      Specified by:
      getCMakeExecutable in class CMakeTask
      Returns:
      Property with the path to the CMake executable file

    • getBuildType

      @Input public org.gradle.api.provider.Property<String> getBuildType()

    • getGenerator

      @Optional @Input public org.gradle.api.provider.Property<String> getGenerator()

    • getToolchain

      @Optional @InputFile public org.gradle.api.provider.Property<String> getToolchain()

    • getArguments

      @Optional @Input public org.gradle.api.provider.ListProperty<String> getArguments()