Package jetbrains.buildServer.serverSide

Class RunType

java.lang.Object

jetbrains.buildServer.serverSide.RunTypeBase

jetbrains.buildServer.serverSide.RunType

All Implemented Interfaces:

ExecutorModeSupport, Describable, RunTypeInfo

Direct Known Subclasses:

PlaceholderRunType, SimpleRunnerRunType, UnknownRunType

public abstract class RunType
extends RunTypeBase
implements RunTypeInfo, ExecutorModeSupport, Describable

Represents a build runner on the server side. RunType instances must be registered via RunTypeRegistry.registerRunType(RunType) method.

Field Summary

Fields

Modifier and Type	Field	Description
static int	RUN_TYPE_NAME_SIZE	Deprecated. use RunTypeInfo.RUN_TYPE_NAME_SIZE

Constructor Summary

Constructors

Constructor	Description
RunType()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
abstract java.lang.String	getDescription()	Returns short description which will be shown in the user interface
abstract java.lang.String	getDisplayName()	Returns name of this runner to show in UI.
abstract java.lang.String	getType()	Returns runner type which should match the BuildRunner.getType.
int	hashCode()
boolean	supports(RunTypeExtension runTypeExtension)	Returns true if given RunTypeExtension can extend given RunType.

Methods inherited from class jetbrains.buildServer.serverSide.RunTypeBase

describeParameters, getDefaultRunnerProperties, getEditRunnerParamsJspFilePath, getIconUrl, getRunnerPropertiesProcessor, getRunnerSpecificRequirements, getTags, getViewRunnerParamsJspFilePath, isSecureParameter, processRunnerRequirements

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jetbrains.buildServer.serverSide.agentless.ExecutorModeSupport

getSupportType

Field Detail

RUN_TYPE_NAME_SIZE

@Deprecated
public static final int RUN_TYPE_NAME_SIZE

Deprecated.

use RunTypeInfo.RUN_TYPE_NAME_SIZE

Limit to size of type name.

See Also:

getType(), Constant Field Values

Constructor Detail

RunType

public RunType()

Method Detail

getType

@NotNull
public abstract java.lang.String getType()

Returns runner type which should match the BuildRunner.getType.

Specified by:

getType in interface RunTypeInfo

Returns:

runner type, will be shown in Runners combobox and should match the BuildRunner.getType The name is limited by RUN_TYPE_NAME_SIZE.

getDisplayName

@NotNull
public abstract java.lang.String getDisplayName()

Returns name of this runner to show in UI.

Specified by:

getDisplayName in interface Describable

Specified by:

getDisplayName in interface RunTypeInfo

Returns:

see above

getDescription

@NotNull
public abstract java.lang.String getDescription()

Returns short description which will be shown in the user interface

Specified by:

getDescription in interface RunTypeInfo

Returns:

see above

supports

public boolean supports(@NotNull
                        RunTypeExtension runTypeExtension)

Returns true if given RunTypeExtension can extend given RunType. I.e. runType may decide if a given extension is supported in it.

Parameters:

runTypeExtension - extension to check

Returns:

see above

Since:

2023.09

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object