Package jetbrains.buildServer.serverSide

Class Compatibility

java.lang.Object

jetbrains.buildServer.serverSide.Compatibility

All Implemented Interfaces:

CompatibilityResult

public class Compatibility
extends Object
implements CompatibilityResult

Author:

Eugene Petrenko Created: 02.09.2009 15:03:25

Constructor Summary

Constructors

Constructor	Description
Compatibility()

Method Summary

Modifier and Type	Method	Description
void	addInvalidRunParameter(InvalidProperty prop)	Adds invalid run parameter on the agent.
void	addMissedVcsPluginOnAgent(String vcsPlugin, String name)	Adds missing required vcs plugin
void	addNotMatchedRequirement(Requirement requirement)	Adds a requirement that does not match on the agent.
void	addUnresolvedParameter(String paramName, String parameterOrigin)	Adds unresolved parameter to the map
RunType	getIncompatibleRunner()	Returns incompatible runner (i.e.
List<InvalidProperty>	getInvalidRunParameters()	Returns invalid runner parameters list.
Map<String,String>	getMissedVcsPluginsOnAgent()	Returns map of VCS plugins required by build configuration which are not installed on the agent.
List<Requirement>	getNonMatchedRequirements()	Returns list of non matched requirements
Map<String,String>	getUndefinedParameters()	Returns map of undefined parameters (parameter references without actual values, i.e.
boolean	isCompatible()	Returns if the configuration is compatible with the agent.
boolean	isSuitableRunnerExists()	Returns true if the specified agent has suitable runner for the configuration.
void	setIncompatibleRunner(RunType runType)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Compatibility

public Compatibility()

Method Detail

isSuitableRunnerExists

public boolean isSuitableRunnerExists()

Description copied from interface: CompatibilityResult

Returns true if the specified agent has suitable runner for the configuration.

Specified by:

isSuitableRunnerExists in interface CompatibilityResult

Returns:

see above

setIncompatibleRunner

public void setIncompatibleRunner(RunType runType)

getIncompatibleRunner

public RunType getIncompatibleRunner()

Description copied from interface: CompatibilityResult

Returns incompatible runner (i.e. runner is defined in build configuration settings but does not exist on agent)

Specified by:

getIncompatibleRunner in interface CompatibilityResult

Returns:

see above

addNotMatchedRequirement

public void addNotMatchedRequirement(@NotNull
                                     Requirement requirement)

Adds a requirement that does not match on the agent.

Parameters:

requirement - non matched requirement

addInvalidRunParameter

public void addInvalidRunParameter(@NotNull
                                   InvalidProperty prop)

Adds invalid run parameter on the agent. Used to build the compatibility object.

Parameters:

prop - invalid property on the agent.

addUnresolvedParameter

public void addUnresolvedParameter(@NotNull
                                   String paramName,
                                   @NotNull
                                   String parameterOrigin)

Adds unresolved parameter to the map

Parameters:

paramName - parameter name

parameterOrigin - origin of the parameter - i.e. place where parameter reference was specified

getInvalidRunParameters

@NotNull
public List<InvalidProperty> getInvalidRunParameters()

Description copied from interface: CompatibilityResult

Returns invalid runner parameters list.

Specified by:

getInvalidRunParameters in interface CompatibilityResult

Returns:

see above

getNonMatchedRequirements

@NotNull
public List<Requirement> getNonMatchedRequirements()

Description copied from interface: CompatibilityResult

Returns list of non matched requirements

Specified by:

getNonMatchedRequirements in interface CompatibilityResult

Returns:

see above

isCompatible

public boolean isCompatible()

Returns if the configuration is compatible with the agent.

Specified by:

isCompatible in interface CompatibilityResult

Returns:

if the configuration is compatible with the agent.

addMissedVcsPluginOnAgent

public void addMissedVcsPluginOnAgent(@NotNull
                                      String vcsPlugin,
                                      @NotNull
                                      String name)

Adds missing required vcs plugin

Parameters:

vcsPlugin - vcs plugin name

name - name

getMissedVcsPluginsOnAgent

@NotNull
public Map<String,String> getMissedVcsPluginsOnAgent()

Description copied from interface: CompatibilityResult

Returns map of VCS plugins required by build configuration which are not installed on the agent. The key in the map is plugin name, the value is display name of the plugin (suitable for showing in the UI)

Specified by:

getMissedVcsPluginsOnAgent in interface CompatibilityResult

Returns:

see above

getUndefinedParameters

@NotNull
public Map<String,String> getUndefinedParameters()

Description copied from interface: CompatibilityResult

Returns map of undefined parameters (parameter references without actual values, i.e. so called implicit requirements).

Specified by:

getUndefinedParameters in interface CompatibilityResult

Returns:

map of parameter name to parameter origin - short description where reference to parameter is defined

toString

public String toString()

Overrides:

toString in class Object