AbstractWrapperCacheBinaryTask (Grolifant Core API)

org.ysb33r.grolifant5.api.core.wrappers.AbstractWrapperCacheBinaryTask

All Implemented Interfaces and Traits:

ConfigCacheSafeOperations
```
@groovy.transform.CompileStatic
abstract class AbstractWrapperCacheBinaryTask
extends GrolifantDefaultTask
implements ConfigCacheSafeOperations
```
Base class for tasks that cache arbitrary binaries.
Authors:
Schalk W. Cronjé
Since:
2.0

Properties Summary

Properties
Type	Name and description
`Provider<File>`	`locationPropertiesFile`

Constructor Summary

Constructors
Constructor and description
`protected AbstractWrapperCacheBinaryTask (String locationPropertiesDefaultName)` Parameters: `locationPropertiesDefaultName` - The default name for the location properties file.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`exec()`
	`protected java.util.Map<String, String>`	`getAdditionalProperties()` Returns additional properties to be added to the cached binary properties file.
	`protected abstract Provider<String>`	`getBinaryLocationProvider()` Obtains location of executable binary or script
	`protected abstract Provider<String>`	`getBinaryVersionProvider()` Obtains version of binary or script
	`java.util.Map<String, String>`	`getCachedBinaryProperties()`
	`Provider<File>`	`getLocationPropertiesFile()`
	`protected abstract String`	`getPropertiesDescription()` Obtains a description to be added to the cached binary properties file.
	`void`	`setLocationPropertiesFile(Object o)`
	`protected void`	`writePropertiesShellFile(File destFile, java.util.Map<String, String> allprops)` Write a shell file of properties.
	`protected void`	`writeWindowsPropertiesBatFile(File destFile, java.util.Map<String, String> allprops)` Writes a Windows batch file of property values that can be included by a wrapper script.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class GrolifantDefaultTask`	`execTools, fsOperations, jvmTools, projectTools, providerTools, stringTools`

- Property Detail
  - Provider<File> locationPropertiesFile
- Constructor Detail
  - protected AbstractWrapperCacheBinaryTask(String locationPropertiesDefaultName)
    
    Parameters:
    locationPropertiesDefaultName - The default name for the location properties file. Can include a relative path
- Method Detail
  - @TaskAction protected void exec()
  - @Input protected java.util.Map<String, String> getAdditionalProperties()
    
    Returns additional properties to be added to the cached binary properties file. The default implementation returns an empty map.
    Returns:
    Additional properties. Can be empty, but nevber null.
  - @Input protected abstract Provider<String> getBinaryLocationProvider()
    
    Obtains location of executable binary or script
    Returns:
    Location of executable as a string
  - @Input protected abstract Provider<String> getBinaryVersionProvider()
    
    Obtains version of binary or script
    Returns:
    Version as a string. Can be null.
  - @Input java.util.Map<String, String> getCachedBinaryProperties()
  - @OutputFile Provider<File> getLocationPropertiesFile()
  - @Input protected abstract String getPropertiesDescription()
    
    Obtains a description to be added to the cached binary properties file.
    Returns:
    Description. Never null.
  - void setLocationPropertiesFile(Object o)
  - protected void writePropertiesShellFile(File destFile, java.util.Map<String, String> allprops)
    
    Write a shell file of properties. The default implementation simply write a Java properties file as it is compatible enough with POSIX shell files.
    Parameters:
    destFile - Destination file (assumes parent path exists)
    allprops - Properties to write to dot-include file.
  - protected void writeWindowsPropertiesBatFile(File destFile, java.util.Map<String, String> allprops)
    
    Writes a Windows batch file of property values that can be included by a wrapper script. Property values that contain spaces will be wrapped in double quotes.
    Parameters:
    destFile - Destination file (assumes parent path exists)
    allprops - Properties to write to batch file.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractWrapperCacheBinaryTask

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

Provider<File> locationPropertiesFile

Constructor Detail

protected AbstractWrapperCacheBinaryTask(String locationPropertiesDefaultName)

Method Detail

@TaskAction protected void exec()

@Input protected java.util.Map<String, String> getAdditionalProperties()

@Input protected abstract Provider<String> getBinaryLocationProvider()

@Input protected abstract Provider<String> getBinaryVersionProvider()

@Input java.util.Map<String, String> getCachedBinaryProperties()

@OutputFile Provider<File> getLocationPropertiesFile()

@Input protected abstract String getPropertiesDescription()

void setLocationPropertiesFile(Object o)

protected void writePropertiesShellFile(File destFile, java.util.Map<String, String> allprops)

protected void writeWindowsPropertiesBatFile(File destFile, java.util.Map<String, String> allprops)