Package io.jenkins.plugins.dotnet

Class DotNetSDK.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<ToolInstallation>

hudson.tools.ToolDescriptor<DotNetSDK>

io.jenkins.plugins.dotnet.DotNetSDK.DescriptorImpl

All Implemented Interfaces:

PersistentDescriptor, Saveable, OnMaster

Enclosing class:

DotNetSDK

@Extension
@Symbol("dotnetsdk")
public static class DotNetSDK.DescriptorImpl
extends ToolDescriptor<DotNetSDK>
implements PersistentDescriptor

A descriptor for .NET SDK installations.

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
DescriptorImpl()

Method Summary

Modifier and Type	Method	Description
protected FormValidation	checkHomeDirectory(File home)	Performs validation on the installation directory for a .NET SDK.
List<? extends ToolInstaller>	getDefaultInstallers()	Gets the default installer to use for a .NET SDK installation.
String	getDisplayName()	Returns the display name for .NET SDK installations.
DotNetSDK	prepareAndValidateInstance(String name, FilePath workspace, EnvVars env, TaskListener listener)	Gets a .NET SDK installation by its name, and prepare it for use in the specified context.
void	setInstallations(DotNetSDK... sdks)	Sets the set of configured .NET SDK installations.

Methods inherited from class hudson.tools.ToolDescriptor

configure, doCheckHome, doCheckName, getCategory, getDefaultProperties, getInstallations, getPropertyDescriptors

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.PersistentDescriptor

load

Methods inherited from interface hudson.model.Saveable

save

Constructor Details

DescriptorImpl

public DescriptorImpl()

Method Details

checkHomeDirectory

@NonNull
protected FormValidation checkHomeDirectory(@NonNull
 File home)

Performs validation on the installation directory for a .NET SDK.

Overrides:

checkHomeDirectory in class ToolDescriptor<DotNetSDK>

Parameters:

home - The directory to validate.

Returns:

The validation result.

getDefaultInstallers

@NonNull
public List<? extends ToolInstaller> getDefaultInstallers()

Gets the default installer to use for a .NET SDK installation.

Overrides:

getDefaultInstallers in class ToolDescriptor<DotNetSDK>

Returns:

A list containing a single DotNetSDKInstaller instance.

getDisplayName

@NonNull
public String getDisplayName()

Returns the display name for .NET SDK installations.

Overrides:

getDisplayName in class Descriptor<ToolInstallation>

Returns:

".NET SDK" or a localized equivalent.

prepareAndValidateInstance

@NonNull
public DotNetSDK prepareAndValidateInstance(@NonNull
 String name,
 @NonNull
 FilePath workspace,
 @NonNull
 EnvVars env,
 @NonNull
 TaskListener listener)
                                     throws IOException,
InterruptedException

Gets a .NET SDK installation by its name, and prepare it for use in the specified context.

Parameters:

name - The name of the configured .NET SDK installation.

workspace - The workspace to use.

env - The environment to use.

listener - The task listener to use.

Returns:

The requested .NET SDK installation.

Throws:

AbortException - When the SDK installation could not be set up.

IOException - Then an I/O error occurs.

InterruptedException - When processing is interrupted.

setInstallations

public void setInstallations(@NonNull
 DotNetSDK... sdks)

Sets the set of configured .NET SDK installations.

Overrides:

setInstallations in class ToolDescriptor<DotNetSDK>

Parameters:

sdks - The set of configured .NET SDK installations.