AbstractNativeToolchain (Grolifant Core API)

org.ysb33r.grolifant5.api.core.runnable.AbstractNativeToolchain

All Implemented Interfaces and Traits:

ToolLocation
```
@groovy.transform.CompileStatic
abstract class AbstractNativeToolchain
extends Object
implements ToolLocation
```
A base class for implementing toolchains based up on external tools that can be download or found installed on the local filesystem.
Authors:
Schalk W. Cronjé
Since:
5.5

Field Summary

Fields
Modifiers	Name	Description
`protected ConfigCacheSafeOperations`	`ccso`

Properties Summary

Properties
Type	Name and description
`Iterable<String>`	`windowsExtensionSearchOrder`

Constructor Summary

Constructors
Constructor and description
`protected AbstractNativeToolchain (Project project)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`executableByPath(Object path)`
	`void`	`executableBySearchPath(Object baseName)`
	`void`	`executableByVersion(Object version)`
	`protected abstract ExecutableDownloader`	`getDownloader()` Gets the downloader implementation.
	`Provider<File>`	`getExecutable()`
	`Provider<String>`	`getExecutableVersion()`
	`java.util.List<String>`	`getWindowsExtensionSearchOrder()`
	`protected abstract String`	`runExecutableAndReturnVersion(File exe)` Runs the executable and returns the version.
	`void`	`setWindowsExtensionSearchOrder(Iterable<String> order)`
	`void`	`setWindowsExtensionSearchOrder(String[] order)`
	`protected void`	`unsetNonPaths()` This is used when path or search path is set to unset other search mechanisms.
	`protected void`	`unsetPaths()` Unset both the fixed path and search path.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, toString, hashCode, getClass, notify, notifyAll, wait, wait, wait`

- Field Detail
  - protected final ConfigCacheSafeOperations ccso
- Property Detail
  - Iterable<String> windowsExtensionSearchOrder
- Constructor Detail
  - protected AbstractNativeToolchain(Project project)
- Method Detail
  - @Override void executableByPath(Object path)
  - @Override void executableBySearchPath(Object baseName)
  - @Override void executableByVersion(Object version)
  - protected abstract ExecutableDownloader getDownloader()
    
    Gets the downloader implementation. Can throw an exception if downloading is not supported.
    Returns:
    A downloader that can be used to retrieve an executable.
  - @Override Provider<File> getExecutable()
  - Provider<String> getExecutableVersion()
  - @Override java.util.List<String> getWindowsExtensionSearchOrder()
  - protected abstract String runExecutableAndReturnVersion(File exe)
    
    Runs the executable and returns the version. See ExecTools.parseVersionFromOutput as a helper to implement this method.
    throws:
    org.ysb33r.grolifant5.api.errors.ConfigurationException if configuration is not correct or version could not be determined.
    
    Parameters:
    exe - Executable location
    Returns:
    Version string.
  - @Override void setWindowsExtensionSearchOrder(Iterable<String> order)
  - @Override void setWindowsExtensionSearchOrder(String[] order)
  - protected void unsetNonPaths()
    
    This is used when path or search path is set to unset other search mechanisms. This is primarily intended to be used within Grolifant itself as part of its base classes and MUST be overridden in those. The default operation is NOOP.
  - protected void unsetPaths()
    
    Unset both the fixed path and search path. THis can be used by derived classes to ensure that paths are not included in exectuble resolution

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractNativeToolchain

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected final ConfigCacheSafeOperations ccso

Property Detail

Iterable<String> windowsExtensionSearchOrder

Constructor Detail

protected AbstractNativeToolchain(Project project)

Method Detail

@Override void executableByPath(Object path)

@Override void executableBySearchPath(Object baseName)

@Override void executableByVersion(Object version)

protected abstract ExecutableDownloader getDownloader()

@Override Provider<File> getExecutable()

Provider<String> getExecutableVersion()

@Override java.util.List<String> getWindowsExtensionSearchOrder()

protected abstract String runExecutableAndReturnVersion(File exe)

@Override void setWindowsExtensionSearchOrder(Iterable<String> order)

@Override void setWindowsExtensionSearchOrder(String[] order)

protected void unsetNonPaths()

protected void unsetPaths()