com.synopsys.arc.jenkinsci.plugins.customtools.versions

Class ToolVersion

java.lang.Object

com.synopsys.arc.jenkinsci.plugins.customtools.versions.ToolVersion

All Implemented Interfaces:

Serializable

public class ToolVersion
extends Object
implements Serializable

A stub for a tool versions.

Since:

0.4

Author:

Oleg Nenashev

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULTS_SOURCE

Constructor Summary

Constructors

Constructor and Description
ToolVersion(String variableName, String defaultVersion, String actualVersion, String versionSource)

Method Summary

Modifier and Type	Method and Description
String	getActualVersion()
static ToolVersion	getDefaultToolVersion(CustomTool tool) Retrieves the default CustomTool version.
String	getDefaultVersion()
static ToolVersion	getEffectiveToolVersion(CustomTool tool, EnvVars buildEnv, Node node) Method gets effective tool version for the build.
String	getVariableName()
String	getVersionSource()
boolean	hasDefaultVersion()
void	setDefaultVersion(String defaultVersion)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULTS_SOURCE

public static final String DEFAULTS_SOURCE

See Also:

Constant Field Values

Constructor Detail

ToolVersion

public ToolVersion(String variableName,
                   @CheckForNull
                   String defaultVersion,
                   @CheckForNull
                   String actualVersion,
                   @CheckForNull
                   String versionSource)

Method Detail

hasDefaultVersion

public boolean hasDefaultVersion()

getDefaultVersion

@CheckForNull
public String getDefaultVersion()

setDefaultVersion

public void setDefaultVersion(@CheckForNull
                              String defaultVersion)

getVariableName

public String getVariableName()

getActualVersion

@CheckForNull
public String getActualVersion()

getVersionSource

@CheckForNull
public String getVersionSource()

getDefaultToolVersion

@CheckForNull
public static ToolVersion getDefaultToolVersion(@Nonnull
                                                               CustomTool tool)

Retrieves the default CustomTool version.

Parameters:

tool - Tool

Returns:

The default version or null if the versioning is not configured.

getEffectiveToolVersion

@CheckForNull
public static ToolVersion getEffectiveToolVersion(CustomTool tool,
                                                                 EnvVars buildEnv,
                                                                 Node node)

Method gets effective tool version for the build.

Parameters:

tool - Custom tool

buildEnv - Current build environment

node - Node, where the build runs

Returns:

Effective tool version. Null if the version is unavailable

toString

public String toString()

Overrides:

toString in class Object