Package io.jenkins.plugins.dotnet
Class 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
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected FormValidation
checkHomeDirectory
(File home) Performs validation on the installation directory for a .NET SDK.List<? extends ToolInstaller>
Gets the default installer to use for a .NET SDK installation.Returns the display name for .NET SDK installations.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
-
Constructor Details
-
DescriptorImpl
public DescriptorImpl()
-
-
Method Details
-
checkHomeDirectory
Performs validation on the installation directory for a .NET SDK.- Overrides:
checkHomeDirectory
in classToolDescriptor<DotNetSDK>
- Parameters:
home
- The directory to validate.- Returns:
- The validation result.
-
getDefaultInstallers
Gets the default installer to use for a .NET SDK installation.- Overrides:
getDefaultInstallers
in classToolDescriptor<DotNetSDK>
- Returns:
- A list containing a single
DotNetSDKInstaller
instance.
-
getDisplayName
Returns the display name for .NET SDK installations.- Overrides:
getDisplayName
in classDescriptor<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
Sets the set of configured .NET SDK installations.- Overrides:
setInstallations
in classToolDescriptor<DotNetSDK>
- Parameters:
sdks
- The set of configured .NET SDK installations.
-