Package org.springframework.boot.gradle.tasks.buildinfo

Class BuildInfo

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.springframework.boot.gradle.tasks.buildinfo.BuildInfo
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
@DisableCachingByDefault(because="Not worth caching") public class BuildInfo extends org.gradle.api.internal.ConventionTask
Task for generating a build-info.properties file from a Project.
Since:
2.0.0
Author:
Andy Wilkinson

  • 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
    BuildInfo()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    generateBuildProperties()
    Generates the build-info.properties file in the configured destination.
    File
    getDestinationDir()
    Returns the directory to which the build-info.properties file will be written.
    BuildInfoProperties
    getProperties()
    Returns the properties that will be included in the build-info.properties file.
    void
    properties(org.gradle.api.Action<BuildInfoProperties> action)
    Executes the given action on the getProperties() properties.
    void
    setDestinationDir(File destinationDir)
    Sets the directory to which the build-info.properties file will be written.

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

    conventionMapping, conventionMapping, getConventionMapping

    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, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

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

    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

    • BuildInfo

      public BuildInfo()

  • Method Details

    • generateBuildProperties

      public void generateBuildProperties()
      Generates the build-info.properties file in the configured destination.

    • getDestinationDir

      @OutputDirectory public File getDestinationDir()
      Returns the directory to which the build-info.properties file will be written. Defaults to the Project's build directory.
      Returns:
      the destination directory

    • setDestinationDir

      public void setDestinationDir(File destinationDir)
      Sets the directory to which the build-info.properties file will be written.
      Parameters:
      destinationDir - the destination directory

    • getProperties

      public BuildInfoProperties getProperties()
      Returns the properties that will be included in the build-info.properties file.
      Returns:
      the properties

    • properties

      public void properties(org.gradle.api.Action<BuildInfoProperties> action)
      Executes the given action on the getProperties() properties.
      Parameters:
      action - the action