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:

java.lang.Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, org.gradle.util.Configurable<Task>

public class BuildInfo
extends org.gradle.api.internal.ConventionTask

Task for generating a build-info.properties file from a Project.

Author:

Andy Wilkinson

Nested Class Summary

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

Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

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

Constructor Summary

Constructors

Constructor and Description
BuildInfo()

Method Summary

Modifier and Type	Method and Description
void	generateBuildProperties() Generates the build-info.properties file in the configured destination.
java.io.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(Action<BuildInfoProperties> action) Executes the given action on the getProperties() properties.
void	setDestinationDir(java.io.File destinationDir) Sets the directory to which the build-info.properties file will be written.
void	setDestinationDir(Provider<java.io.File> destinationDirProvider) Sets the directory to which the build-info.properties file will be written to the value from the given destinationDirProvider.

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

conventionMapping, conventionMapping, getConventionMapping

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

addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildInfo

public BuildInfo()

Method Detail

generateBuildProperties

public void generateBuildProperties()

Generates the build-info.properties file in the configured destination.

getDestinationDir

@OutputDirectory
public java.io.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(java.io.File destinationDir)

Sets the directory to which the build-info.properties file will be written.

Parameters:

destinationDir - the destination directory

setDestinationDir

public void setDestinationDir(Provider<java.io.File> destinationDirProvider)

Sets the directory to which the build-info.properties file will be written to the value from the given destinationDirProvider.

Parameters:

destinationDirProvider - the provider of the destination directory

getProperties

@Input
public BuildInfoProperties getProperties()

Returns the properties that will be included in the build-info.properties file.

Returns:

the properties

properties

public void properties(Action<BuildInfoProperties> action)

Executes the given action on the getProperties() properties.

Parameters:

action - the action