Package com.intellij.openapi.externalSystem.settings

Class ExternalSystemSettingsListenerAdapter<S extends ExternalProjectSettings>

java.lang.Object

com.intellij.openapi.externalSystem.settings.ExternalSystemSettingsListenerAdapter<S>

All Implemented Interfaces:

ExternalSystemSettingsListener<S>

Direct Known Subclasses:

GradleSettingsListenerAdapter

public abstract class ExternalSystemSettingsListenerAdapter<S extends ExternalProjectSettings>
extends java.lang.Object
implements ExternalSystemSettingsListener<S>

Constructor Summary

Constructors

Constructor and Description
ExternalSystemSettingsListenerAdapter()

Method Summary

Modifier and Type	Method and Description
void	onBulkChangeEnd()
void	onBulkChangeStart() External system settings changes might affect project structure, e.g.
void	onProjectRenamed(java.lang.String oldName, java.lang.String newName) This method is present here only because IJ platform doesn't has corresponding messaging set up for 'project rename' event.
void	onProjectsLinked(java.util.Collection<S> settings)
void	onProjectsLoaded(java.util.Collection<S> settings) Happens after loading of project settings
void	onProjectsUnlinked(java.util.Set<java.lang.String> linkedProjectPaths)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.externalSystem.settings.ExternalSystemSettingsListener

onUseAutoImportChange

Constructor Detail

ExternalSystemSettingsListenerAdapter

public ExternalSystemSettingsListenerAdapter()

Method Detail

onProjectRenamed

public void onProjectRenamed(java.lang.String oldName,
                             java.lang.String newName)

Description copied from interface: ExternalSystemSettingsListener

This method is present here only because IJ platform doesn't has corresponding messaging set up for 'project rename' event.

Specified by:

onProjectRenamed in interface ExternalSystemSettingsListener<S extends ExternalProjectSettings>

Parameters:

oldName - old project name

newName - new project name

onProjectsLoaded

public void onProjectsLoaded(java.util.Collection<S> settings)

Description copied from interface: ExternalSystemSettingsListener

Happens after loading of project settings

Specified by:

onProjectsLoaded in interface ExternalSystemSettingsListener<S extends ExternalProjectSettings>

See Also:

AbstractExternalSystemSettings.loadState(com.intellij.openapi.externalSystem.settings.AbstractExternalSystemSettings.State<PS>), PersistentStateComponent.loadState(T)

onProjectsLinked

public void onProjectsLinked(java.util.Collection<S> settings)

Specified by:

onProjectsLinked in interface ExternalSystemSettingsListener<S extends ExternalProjectSettings>

onProjectsUnlinked

public void onProjectsUnlinked(java.util.Set<java.lang.String> linkedProjectPaths)

Specified by:

onProjectsUnlinked in interface ExternalSystemSettingsListener<S extends ExternalProjectSettings>

onBulkChangeStart

public void onBulkChangeStart()

Description copied from interface: ExternalSystemSettingsListener

External system settings changes might affect project structure, e.g. switching from one external system version to another one can trigger new binaries usage (different external system versions might use different file system directories for holding dependencies).

So, we might want to refresh project structure on external system setting change. However, there is a possible case that more than one significant setting is changed during single editing session (e.g. a user opens external system settings, changes linked project path and 'use auto-import' and then presses 'Ok'.). We don't want to trigger two refreshes then. That's why it's possible to indicate that settings are changed in bulk now.

ExternalSystemSettingsListener.onBulkChangeEnd() is expected to be called at the 'finally' section which starts just after the call to current method.

Specified by:

onBulkChangeStart in interface ExternalSystemSettingsListener<S extends ExternalProjectSettings>

onBulkChangeEnd

public void onBulkChangeEnd()

Specified by:

onBulkChangeEnd in interface ExternalSystemSettingsListener<S extends ExternalProjectSettings>

See Also:

ExternalSystemSettingsListener.onBulkChangeStart()