ToolVersion (javadoc 2024.12-174331 API)

All Known Subinterfaces:

BundledToolVersion, DownloadableToolVersion, InstalledToolVersion, InstalledToolVersionEx

All Known Implementing Classes:

BundledToolVersionImpl, CustomArchiveToolVersion, DirectoryToolVersion, InstalledToolVersionImpl, RemoteInstalledToolVersionImpl, SimpleInstalledToolVersion, SimpleToolVersion
```
public interface ToolVersion
```
Created by Evgeniy.Koshkin on 15-Jan-16.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`String`	`getDisplayName()`
`String`	`getId()`
`default ToolInstallationMode`	`getInstallationMode()`	Returns the installation mode for this tool version.
`default String`	`getOriginalId()`
`default Long`	`getRequiredFreeDiskSpaceHint()`	Returns an approximate amount of free disk space in bytes required to install this tool version.
`ToolType`	`getType()`
`String`	`getVersion()`
`default boolean`	`isBundled()`

- Method Detail
  - getType
```
@NotNull
ToolType getType()
```
  - getVersion
```
@NotNull
String getVersion()
```
  - getId
```
@NotNull
String getId()
```
  - getOriginalId
```
@NotNull
default String getOriginalId()
```
    Since:
    
    2023.11
  - getDisplayName
```
@NotNull
String getDisplayName()
```
  - isBundled
```
default boolean isBundled()
```
    Since:
    
    2023.11
  - getRequiredFreeDiskSpaceHint
```
@Nullable
default Long getRequiredFreeDiskSpaceHint()
```
    Returns an approximate amount of free disk space in bytes required to install this tool version. It is recommended to round the value up, e.g. if it's required to have ~4.5 GB, it's better to return a bigger value, e.g. 5 GB.
    The implementation of this method is optional but recommended for downloadable bundled tool versions.
    
    Since:
    
    2023.11
  - getInstallationMode
```
@NotNull
default ToolInstallationMode getInstallationMode()
```
    Returns the installation mode for this tool version. This mode is only applicable to downloadable bundled tool versions and is used during TeamCity server startup to determine whether the downloadable bundled tool version should be installed.
    
    Since:
    
    2024.03