Package com.intellij.openapi.updateSettings

Class UpdateStrategyCustomization

java.lang.Object

com.intellij.openapi.updateSettings.UpdateStrategyCustomization

public class UpdateStrategyCustomization
extends java.lang.Object

Override this service in your IDE to customize update behavior. It isn't supposed to be overridden in plugins.

Constructor Summary

Constructors

Constructor and Description
UpdateStrategyCustomization()

Method Summary

Modifier and Type	Method and Description
boolean	forceEapUpdateChannelForEapBuilds()
static UpdateStrategyCustomization	getInstance()
boolean	haveSameMajorVersion(BuildNumber build1, BuildNumber build2) Returns true if the both passed builds correspond to the same major version of the IDE.
boolean	isChannelActive(ChannelStatus channel)
boolean	isNewerVersion(BuildNumber candidateBuild, BuildNumber currentBuild) Returns true if version of candidateBuild is newer than version of currentBuild so it may be suggested as an update.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateStrategyCustomization

public UpdateStrategyCustomization()

Method Detail

getInstance

public static UpdateStrategyCustomization getInstance()

forceEapUpdateChannelForEapBuilds

public boolean forceEapUpdateChannelForEapBuilds()

isChannelActive

public boolean isChannelActive(ChannelStatus channel)

haveSameMajorVersion

public boolean haveSameMajorVersion(BuildNumber build1,
                                    BuildNumber build2)

Returns true if the both passed builds correspond to the same major version of the IDE. The platform uses this method when several new builds are available, to suggest updating to the build from the same major version, i.e. IntelliJ IDEA 2018.2.5 will suggest to update to 2018.2.6, not to 2018.3.
Override this method if major versions of your IDE doesn't directly correspond to major version of the IntelliJ platform.

isNewerVersion

public boolean isNewerVersion(BuildNumber candidateBuild,
                              BuildNumber currentBuild)

Returns true if version of candidateBuild is newer than version of currentBuild so it may be suggested as an update.
If you use composite version numbers in your IDE (e.g. to be able to release new versions in parallel with bugfix updates for older versions) and append them to the build number of the platform they are based on, it may happen that a newer version of your IDE is based on an older version of the platform, so a bug fix update for an old version will have build number greater than the build number of a new version. In this case you need to override this method and compare components of build numbers which correspond to your IDE's version to ensure that the old version won't be suggested as an update to the new version.