PackageManagementService (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.webcore.packaging.PackageManagementService

Direct Known Subclasses:: PackageManagementServiceEx

public abstract class PackageManagementService
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PackageManagementService.ErrorDescription

static interface PackageManagementService.Listener

Nested Classes
Modifier and Type	Class and Description
`static class`	`PackageManagementService.ErrorDescription`
`static interface`	`PackageManagementService.Listener`

Constructor Summary

Constructors
Constructor and Description

PackageManagementService()

Constructors
Constructor and Description
`PackageManagementService()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addRepository(java.lang.String repositoryUrl)`
`boolean`	`canInstallToUser()` Returns true if the 'install to user' checkbox should be visible.
`boolean`	`canManageRepositories()` Returns true if the service supports managing repositories.
`boolean`	`canModifyRepository(java.lang.String repositoryUrl)` Checks if the user can change the URL of the specified repository or remove it from the list.
`int`	`compareVersions(java.lang.String version1, java.lang.String version2)`
`void`	`fetchAllRepositories(CatchingConsumer<? super java.util.List<java.lang.String>,? super java.lang.Exception> consumer)` An async version of `getAllRepositories()`.
`abstract void`	`fetchPackageDetails(java.lang.String packageName, CatchingConsumer<java.lang.String,java.lang.Exception> consumer)`
`abstract void`	`fetchPackageVersions(java.lang.String packageName, CatchingConsumer<java.util.List<java.lang.String>,java.lang.Exception> consumer)`
`abstract java.util.List<RepoPackage>`	`getAllPackages()` Returns the list of all packages in all configured repositories.
`java.util.List<RepoPackage>`	`getAllPackagesCached()` Returns the cached list of all packages in all configured repositories, or an empty list if there is no cached information available.
`java.util.List<java.lang.String>`	`getAllRepositories()` Returns the list of URLs for all configured package repositories.
`java.lang.String`	`getID()`
`abstract java.util.Collection<InstalledPackage>`	`getInstalledPackages()` Returns the list of packages which are currently installed.
`java.lang.String`	`getInstallToUserText()` Returns the text of the 'install to user' checkbox.
`abstract void`	`installPackage(RepoPackage repoPackage, java.lang.String version, boolean forceUpgrade, java.lang.String extraOptions, PackageManagementService.Listener listener, boolean installToUser)` Installs the specified package.
`void`	`installToUserChanged(boolean newValue)` Called when the 'install to user' checkbox is checked or unchecked.
`boolean`	`isInstallToUserSelected()` Returns true if the 'install to user' checkbox should be initially selected.
`abstract java.util.List<RepoPackage>`	`reloadAllPackages()` Reloads the lists of packages for all configured repositories and returns the results.
`void`	`removeRepository(java.lang.String repositoryUrl)`
`abstract void`	`uninstallPackages(java.util.List<InstalledPackage> installedPackages, PackageManagementService.Listener listener)`

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

- Constructor Detail
  - PackageManagementService
```
public PackageManagementService()
```
- Method Detail
  - getAllRepositories
```
public java.util.List<java.lang.String> getAllRepositories()
```
    Returns the list of URLs for all configured package repositories.
    
    Returns:
    
    list of URLs, or null if the repository management is not supported by this package management service.
  - fetchAllRepositories
```
public void fetchAllRepositories(CatchingConsumer<? super java.util.List<java.lang.String>,? super java.lang.Exception> consumer)
```
    An async version of getAllRepositories().
  - canManageRepositories
```
public boolean canManageRepositories()
```
    Returns true if the service supports managing repositories.
  - canModifyRepository
```
public boolean canModifyRepository(java.lang.String repositoryUrl)
```
    Checks if the user can change the URL of the specified repository or remove it from the list.
    
    Parameters:
    
    repositoryUrl - the URL to check
    
    Returns:
    
    true if can be modified, false otherwise.
  - addRepository
```
public void addRepository(java.lang.String repositoryUrl)
```
  - removeRepository
```
public void removeRepository(java.lang.String repositoryUrl)
```
  - compareVersions
```
public int compareVersions(java.lang.String version1,
                           java.lang.String version2)
```
    Returns:
    
    a negative integer, if the first version is older than the second, zero, if the versions are equals, a positive integer, if the first version is newer than the second.
  - getAllPackages
```
public abstract java.util.List<RepoPackage> getAllPackages()
                                                    throws java.io.IOException
```
    Returns the list of all packages in all configured repositories. Called in a background thread and may initiate network connections. May return cached data.
    
    Returns:
    
    the list of all packages in all repositories
    
    Throws:
    
    java.io.IOException
  - reloadAllPackages
```
public abstract java.util.List<RepoPackage> reloadAllPackages()
                                                       throws java.io.IOException
```
    Reloads the lists of packages for all configured repositories and returns the results. Called in a background thread and may initiate network connections. May not return cached data.
    
    Returns:
    
    the list of all packages in all repositories
    
    Throws:
    
    java.io.IOException
  - getAllPackagesCached
```
public java.util.List<RepoPackage> getAllPackagesCached()
```
    Returns the cached list of all packages in all configured repositories, or an empty list if there is no cached information available.
    
    Returns:
    
    the list of all packages or an empty list.
  - canInstallToUser
```
public boolean canInstallToUser()
```
    Returns true if the 'install to user' checkbox should be visible.
  - getInstallToUserText
```
public java.lang.String getInstallToUserText()
```
    Returns the text of the 'install to user' checkbox.
    
    Returns:
    
    the text of the 'install to user' checkbox.
  - isInstallToUserSelected
```
public boolean isInstallToUserSelected()
```
    Returns true if the 'install to user' checkbox should be initially selected.
  - installToUserChanged
```
public void installToUserChanged(boolean newValue)
```
    Called when the 'install to user' checkbox is checked or unchecked.
  - getInstalledPackages
```
public abstract java.util.Collection<InstalledPackage> getInstalledPackages()
                                                                     throws java.io.IOException
```
    Returns the list of packages which are currently installed.
    
    Returns:
    
    the collection of currently installed packages.
    
    Throws:
    
    java.io.IOException
  - installPackage
```
public abstract void installPackage(RepoPackage repoPackage,
                                    java.lang.String version,
                                    boolean forceUpgrade,
                                    java.lang.String extraOptions,
                                    PackageManagementService.Listener listener,
                                    boolean installToUser)
```
    Installs the specified package. Called in the event dispatch thread; needs to take care of spawning a background task itself.
    
    Parameters:
    
    repoPackage - the package to install
    
    version - the version selected by the user, or null if the checkbox to install a specific version is not checked
    
    forceUpgrade - if true, the latest version of the package is installed even if there is already an installed version
    
    extraOptions - additional options entered by the user
    
    listener - the listener that must be called to publish information about the installation progress
    
    installToUser - the state of the "install to user" checkbox (ignore if not applicable)
  - uninstallPackages
```
public abstract void uninstallPackages(java.util.List<InstalledPackage> installedPackages,
                                       PackageManagementService.Listener listener)
```
  - fetchPackageVersions
```
public abstract void fetchPackageVersions(java.lang.String packageName,
                                          CatchingConsumer<java.util.List<java.lang.String>,java.lang.Exception> consumer)
```
  - fetchPackageDetails
```
public abstract void fetchPackageDetails(java.lang.String packageName,
                                         CatchingConsumer<java.lang.String,java.lang.Exception> consumer)
```
  - getID
```
public java.lang.String getID()
```
    Returns:
    
    identifier of this service for reported usage data (sent for JetBrains implementations only). Return null to avoid reporting any usage data.

Class PackageManagementService

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PackageManagementService

Method Detail

getAllRepositories

fetchAllRepositories

canManageRepositories

canModifyRepository

addRepository

removeRepository

compareVersions

getAllPackages

reloadAllPackages

getAllPackagesCached

canInstallToUser

getInstallToUserText

isInstallToUserSelected

installToUserChanged

getInstalledPackages

installPackage

uninstallPackages

fetchPackageVersions

fetchPackageDetails

getID