jetbrains.buildServer.serverSide
Class Compatibility

java.lang.Object
  extended by jetbrains.buildServer.serverSide.Compatibility
All Implemented Interfaces:
CompatibilityResult

public class Compatibility
extends java.lang.Object
implements CompatibilityResult

Author:
Eugene Petrenko Created: 02.09.2009 15:03:25

Constructor Summary
Compatibility()
           
 
Method Summary
 void addInvalidRunParameter(InvalidProperty prop)
          Adds invalid run parameter on the agent.
 void addMissedVcsPluginOnAgent(java.lang.String vcsPlugin, java.lang.String name)
          Adds missing required vcs plugin
 void addNotMatchedRequirement(Requirement requirement)
          Adds a requirement that does not match on the agent.
 void addUnresolvedParameter(java.lang.String paramName, java.lang.String parameterOrigin)
          Adds unresolved parameter to the map
 RunType getIncompatibleRunner()
          Returns incompatible runner (i.e.
 java.util.List<InvalidProperty> getInvalidRunParameters()
          Returns invalid runner parameters list.
 java.util.Map<java.lang.String,java.lang.String> getMissedVcsPluginsOnAgent()
          Returns map of VCS plugins required by build configuration which are not installed on the agent.
 java.util.List<Requirement> getNonMatchedRequirements()
          Returns list of non matched requirements
 java.util.Map<java.lang.String,java.lang.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)
           
 java.lang.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
                                   java.lang.String paramName,
                                   @NotNull
                                   java.lang.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 java.util.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 java.util.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
                                      java.lang.String vcsPlugin,
                                      @NotNull
                                      java.lang.String name)
Adds missing required vcs plugin

Parameters:
vcsPlugin - vcs plugin name
name - name

getMissedVcsPluginsOnAgent

@NotNull
public java.util.Map<java.lang.String,java.lang.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 java.util.Map<java.lang.String,java.lang.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 java.lang.String toString()
Overrides:
toString in class java.lang.Object