SdkType (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.projectRoots.SdkType

All Implemented Interfaces:

SdkTypeId

Direct Known Subclasses:

DependentSdkType, JavaSdk, PythonSdkType, SimpleJavaSdkType, UnknownSdkType
```
public abstract class SdkType
extends java.lang.Object
implements SdkTypeId
```

Field Summary

Fields
Modifier and Type Field and Description

static ExtensionPointName<SdkType> EP_NAME

Fields
Modifier and Type	Field and Description
`static ExtensionPointName<SdkType>`	`EP_NAME`

Constructor Summary

Constructors
Constructor and Description

SdkType(java.lang.String name)

Constructors
Constructor and Description
`SdkType(java.lang.String name)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`adjustSelectedSdkHome(java.lang.String homePath)` If a path selected in the file chooser is not a valid SDK home path, returns an adjusted version of the path that is again checked for validity.
`boolean`	`allowCreationByUser()` If this method returns false, this SDK type will not be shown in the SDK type chooser popup when the user creates a new SDK.
`abstract AdditionalDataConfigurable`	`createAdditionalDataConfigurable(SdkModel sdkModel, SdkModificator sdkModificator)`
`boolean`	`equals(java.lang.Object o)`
`static SdkType`	`findByName(java.lang.String sdkName)`
`static <T extends SdkType> T`	`findInstance(java.lang.Class<T> sdkTypeClass)`
`static SdkType []`	`getAllTypes()`
`java.util.Comparator<Sdk>`	`getComparator()` Returns a comparator used to order SDKs in project or module settings combo boxes.
`java.lang.String`	`getDefaultDocumentationUrl(Sdk sdk)`
`SdkType`	`getDependencyType()`
`java.lang.String`	`getDownloadSdkUrl()`
`java.lang.String`	`getHelpTopic()`
`FileChooserDescriptor`	`getHomeChooserDescriptor()`
`java.lang.String`	`getHomeFieldLabel()`
`javax.swing.Icon`	`getIcon()`
`javax.swing.Icon`	`getIconForAddAction()`
`java.lang.String`	`getInvalidHomeMessage(java.lang.String path)` Returns the message to be shown to the user when `isValidSdkHome(String)` returned false for the path.
`java.lang.String`	`getName()`
`abstract java.lang.String`	`getPresentableName()`
`java.lang.String`	`getVersionString(Sdk sdk)`
`java.lang.String`	`getVersionString(java.lang.String sdkHome)`
`int`	`hashCode()`
`boolean`	`isRelevantForFile(Project project, VirtualFile file)` This method is used to decide if a given `VirtualFile` has something in common with this `SdkType`.
`boolean`	`isRootTypeApplicable(OrderRootType type)`
`abstract boolean`	`isValidSdkHome(java.lang.String path)`
`SdkAdditionalData`	`loadAdditionalData(Element additional)`
`SdkAdditionalData`	`loadAdditionalData(Sdk currentSdk, Element additional)`
`boolean`	`sdkHasValidPath(Sdk sdk)` Checks if the home directory of the specified SDK is valid.
`java.lang.String`	`sdkPath(VirtualFile homePath)`
`void`	`setupSdkPaths(Sdk sdk)`
`boolean`	`setupSdkPaths(Sdk sdk, SdkModel sdkModel)`
`void`	`showCustomCreateUI(SdkModel sdkModel, javax.swing.JComponent parentComponent, Consumer<Sdk> sdkCreatedCallback)` Deprecated. use `showCustomCreateUI(SdkModel, JComponent, Sdk, Consumer)` method instead
`void`	`showCustomCreateUI(SdkModel sdkModel, javax.swing.JComponent parentComponent, Sdk selectedSdk, Consumer<Sdk> sdkCreatedCallback)` Shows the custom SDK create UI based on selected SDK in parent component.
`abstract java.lang.String`	`suggestHomePath()` Returns a recommended starting path for a file chooser (where SDKs of this type are usually may be found), or `null` if not applicable/no SDKs found.
`java.util.Collection<java.lang.String>`	`suggestHomePaths()` Returns a list of all valid SDKs found on this host.
`abstract java.lang.String`	`suggestSdkName(java.lang.String currentSdkName, java.lang.String sdkHome)`
`boolean`	`supportsCustomCreateUI()` If this method returns true, instead of showing the standard file path chooser when a new SDK of the type is created, the `showCustomCreateUI(com.intellij.openapi.projectRoots.SdkModel, javax.swing.JComponent, com.intellij.openapi.projectRoots.Sdk, com.intellij.util.Consumer<com.intellij.openapi.projectRoots.Sdk>)` method is called.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.intellij.openapi.projectRoots.SdkTypeId
isLocalSdk, saveAdditionalData, versionComparator, versionStringComparator

- Field Detail
  - EP_NAME
```
public static final ExtensionPointName<SdkType> EP_NAME
```
- Constructor Detail
  - SdkType
```
public SdkType(java.lang.String name)
```
- Method Detail
  - suggestHomePath
```
public abstract java.lang.String suggestHomePath()
```
    Returns a recommended starting path for a file chooser (where SDKs of this type are usually may be found), or null if not applicable/no SDKs found.
    E.g. for Python SDK on Unix the method may return either "/usr/bin" or "/usr/bin/python" (if there is only one Python interpreter installed on a host).
  - suggestHomePaths
```
public java.util.Collection<java.lang.String> suggestHomePaths()
```
    Returns a list of all valid SDKs found on this host.
    E.g. for Python SDK on Unix the method may return ["/usr/bin/python2", "/usr/bin/python3"].
  - isRelevantForFile
```
public boolean isRelevantForFile(Project project,
                                 VirtualFile file)
```
    This method is used to decide if a given VirtualFile has something in common with this SdkType. For example, it can be used by the IDE to decide showing SDK related editor notifications or quick fixes
  - adjustSelectedSdkHome
```
public java.lang.String adjustSelectedSdkHome(java.lang.String homePath)
```
    If a path selected in the file chooser is not a valid SDK home path, returns an adjusted version of the path that is again checked for validity.
    
    Parameters:
    
    homePath - the path selected in the file chooser.
    
    Returns:
    
    the path to be used as the SDK home.
  - isValidSdkHome
```
public abstract boolean isValidSdkHome(java.lang.String path)
```
  - getInvalidHomeMessage
```
public java.lang.String getInvalidHomeMessage(java.lang.String path)
```
    Returns the message to be shown to the user when isValidSdkHome(String) returned false for the path.
  - getVersionString
```
public java.lang.String getVersionString(Sdk sdk)
```
    Specified by:
    
    getVersionString in interface SdkTypeId
  - getVersionString
```
public java.lang.String getVersionString(java.lang.String sdkHome)
```
  - suggestSdkName
```
public abstract java.lang.String suggestSdkName(java.lang.String currentSdkName,
                                                java.lang.String sdkHome)
```
  - getComparator
```
public java.util.Comparator<Sdk> getComparator()
```
    Returns a comparator used to order SDKs in project or module settings combo boxes. When different SDK types return the same comparator instance, they are sorted together.
  - setupSdkPaths
```
public boolean setupSdkPaths(Sdk sdk,
                             SdkModel sdkModel)
```
  - setupSdkPaths
```
public void setupSdkPaths(Sdk sdk)
```
  - createAdditionalDataConfigurable
```
public abstract AdditionalDataConfigurable createAdditionalDataConfigurable(SdkModel sdkModel,
                                                                            SdkModificator sdkModificator)
```
    Returns:
    
    Configurable object for the SDKs additional data or null if not applicable
  - loadAdditionalData
```
public SdkAdditionalData loadAdditionalData(Element additional)
```
  - loadAdditionalData
```
public SdkAdditionalData loadAdditionalData(Sdk currentSdk,
                                            Element additional)
```
    Specified by:
    
    loadAdditionalData in interface SdkTypeId
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface SdkTypeId
  - getPresentableName
```
public abstract java.lang.String getPresentableName()
```
  - getIcon
```
public javax.swing.Icon getIcon()
```
  - getHelpTopic
```
public java.lang.String getHelpTopic()
```
  - getIconForAddAction
```
public javax.swing.Icon getIconForAddAction()
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getHomeChooserDescriptor
```
public FileChooserDescriptor getHomeChooserDescriptor()
```
  - getHomeFieldLabel
```
public java.lang.String getHomeFieldLabel()
```
  - getDefaultDocumentationUrl
```
public java.lang.String getDefaultDocumentationUrl(Sdk sdk)
```
  - getDownloadSdkUrl
```
public java.lang.String getDownloadSdkUrl()
```
  - getAllTypes
```
public static SdkType [] getAllTypes()
```
  - findByName
```
public static SdkType findByName(java.lang.String sdkName)
```
  - findInstance
```
public static <T extends SdkType> T findInstance(java.lang.Class<T> sdkTypeClass)
```
  - getDependencyType
```
public SdkType getDependencyType()
```
    Returns:
    
    for sdk build over another sdk, returns type of the nested sdk, e.g. plugins or android sdks are build over java sdk and for them the method returns JavaSdkType, null otherwise
  - isRootTypeApplicable
```
public boolean isRootTypeApplicable(OrderRootType type)
```
  - supportsCustomCreateUI
```
public boolean supportsCustomCreateUI()
```
    If this method returns true, instead of showing the standard file path chooser when a new SDK of the type is created, the showCustomCreateUI(com.intellij.openapi.projectRoots.SdkModel, javax.swing.JComponent, com.intellij.openapi.projectRoots.Sdk, com.intellij.util.Consumer<com.intellij.openapi.projectRoots.Sdk>) method is called.
    
    Returns:
    
    true if the custom create UI is supported, false otherwise.
  - showCustomCreateUI
```
public void showCustomCreateUI(SdkModel sdkModel,
                               javax.swing.JComponent parentComponent,
                               Sdk selectedSdk,
                               Consumer<Sdk> sdkCreatedCallback)
```
    Shows the custom SDK create UI based on selected SDK in parent component. The returned SDK needs to have the correct name and home path; the framework will call setupSdkPaths() on the returned SDK.
    
    Parameters:
    
    sdkModel - the list of SDKs currently displayed in the configuration dialog.
    
    parentComponent - the parent component for showing the dialog.
    
    selectedSdk - current selected sdk in parentComponent
    
    sdkCreatedCallback - the callback to which the created SDK is passed.
    
    See Also:
    
    supportsCustomCreateUI()
  - showCustomCreateUI
```
@Deprecated
public void showCustomCreateUI(SdkModel sdkModel,
                               javax.swing.JComponent parentComponent,
                               Consumer<Sdk> sdkCreatedCallback)
```
    Deprecated. use showCustomCreateUI(SdkModel, JComponent, Sdk, Consumer) method instead
  - sdkHasValidPath
```
public boolean sdkHasValidPath(Sdk sdk)
```
    Checks if the home directory of the specified SDK is valid. By default, checks that the directory points to a valid local path. Can be overridden for remote SDKs.
    
    Parameters:
    
    sdk - the SDK to validate the path for.
    
    Returns:
    
    true if the home path is valid, false otherwise.
  - sdkPath
```
public java.lang.String sdkPath(VirtualFile homePath)
```
  - allowCreationByUser
```
public boolean allowCreationByUser()
```
    If this method returns false, this SDK type will not be shown in the SDK type chooser popup when the user creates a new SDK.

Class SdkType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.intellij.openapi.projectRoots.SdkTypeId

Field Detail

EP_NAME

Constructor Detail

SdkType

Method Detail

suggestHomePath

suggestHomePaths

isRelevantForFile

adjustSelectedSdkHome

isValidSdkHome

getInvalidHomeMessage

getVersionString

getVersionString

suggestSdkName

getComparator

setupSdkPaths

setupSdkPaths

createAdditionalDataConfigurable

loadAdditionalData

loadAdditionalData

getName

getPresentableName

getIcon

getHelpTopic

getIconForAddAction

equals

hashCode

toString

getHomeChooserDescriptor

getHomeFieldLabel

getDefaultDocumentationUrl

getDownloadSdkUrl

getAllTypes

findByName

findInstance

getDependencyType

isRootTypeApplicable

supportsCustomCreateUI

showCustomCreateUI

showCustomCreateUI

sdkHasValidPath

sdkPath

allowCreationByUser