Package com.intellij.openapi.externalSystem.settings

Class AbstractExternalSystemSettings<SS extends AbstractExternalSystemSettings<SS,PS,L>,PS extends ExternalProjectSettings,L extends ExternalSystemSettingsListener<PS>>

java.lang.Object

com.intellij.openapi.externalSystem.settings.AbstractExternalSystemSettings<SS,PS,L>

All Implemented Interfaces:

Disposable

Direct Known Subclasses:

GradleSettings

public abstract class AbstractExternalSystemSettings<SS extends AbstractExternalSystemSettings<SS,PS,L>,PS extends ExternalProjectSettings,L extends ExternalSystemSettingsListener<PS>>
extends java.lang.Object
implements Disposable

Common base class for external system settings. Defines a minimal api which is necessary for the common external system support codebase.

Note: non-abstract sub-classes of this class are expected to be marked by AbstractExternalSystemSettings.State annotation configured as necessary.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractExternalSystemSettings.State<S>

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractExternalSystemSettings(Topic<L> topic, Project project)

Method Summary

Modifier and Type	Method and Description
protected abstract void	checkSettings(PS old, PS current) Is assumed to check if given old settings external system-specific state differs from the given new one and notify listeners in case of the positive answer.
protected abstract void	copyExtraSettingsFrom(SS settings)
void	copyFrom(SS settings)
void	dispose() Usually not invoked directly, see class javadoc.
protected void	doSubscribe(L listener, Disposable parentDisposable) Generic subscribe implementation
protected void	fillState(AbstractExternalSystemSettings.State<PS> state)
Topic<L>	getChangesTopic()
PS	getLinkedProjectSettings(java.lang.String linkedProjectPath)
java.util.Collection<PS>	getLinkedProjectsSettings()
Project	getProject()
L	getPublisher()
void	linkProject(PS settings)
protected void	loadState(AbstractExternalSystemSettings.State<PS> state)
void	setLinkedProjectsSettings(java.util.Collection<? extends PS> settings)
boolean	showSelectiveImportDialogOnInitialImport()
abstract void	subscribe(ExternalSystemSettingsListener<PS> listener) Deprecated. use/implements subscribe(ExternalSystemSettingsListener, Disposable) instead
void	subscribe(ExternalSystemSettingsListener<PS> listener, Disposable parentDisposable) Every time particular external system setting is changed corresponding message is sent via ide messaging sub-system.
boolean	unlinkExternalProject(java.lang.String linkedProjectPath) Un-links given external project from the current ide project.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExternalSystemSettings

protected AbstractExternalSystemSettings(Topic<L> topic,
                                         Project project)

Method Detail

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

getProject

public Project getProject()

showSelectiveImportDialogOnInitialImport

public boolean showSelectiveImportDialogOnInitialImport()

subscribe

public void subscribe(ExternalSystemSettingsListener<PS> listener,
                      Disposable parentDisposable)

Every time particular external system setting is changed corresponding message is sent via ide messaging sub-system. The problem is that every external system implementation defines it's own topic/listener pair. Listener interface is derived from the common ExternalSystemSettingsListener interface and is specific to external sub-system implementation. However, it's possible that a client wants to perform particular actions based only on ExternalSystemSettingsListener facilities. There is no way for such external system-agnostic client to create external system-specific listener implementation then.

That's why this method allows to wrap given 'generic listener' into external system-specific one.

Parameters:

listener - target generic listener to wrap to external system-specific implementation

parentDisposable - is a disposable to unsubscribe from external system settings events

subscribe

@Deprecated
public abstract void subscribe(ExternalSystemSettingsListener<PS> listener)

Deprecated. use/implements subscribe(ExternalSystemSettingsListener, Disposable) instead

See Also:

subscribe(ExternalSystemSettingsListener, Disposable)

doSubscribe

protected void doSubscribe(L listener,
                           Disposable parentDisposable)

Generic subscribe implementation

See Also:

subscribe(ExternalSystemSettingsListener, Disposable)

copyFrom

public void copyFrom(SS settings)

copyExtraSettingsFrom

protected abstract void copyExtraSettingsFrom(SS settings)

getLinkedProjectsSettings

public java.util.Collection<PS> getLinkedProjectsSettings()

getLinkedProjectSettings

public PS getLinkedProjectSettings(java.lang.String linkedProjectPath)

linkProject

public void linkProject(PS settings)
                 throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

unlinkExternalProject

public boolean unlinkExternalProject(java.lang.String linkedProjectPath)

Un-links given external project from the current ide project.

Parameters:

linkedProjectPath - path of external project to be unlinked

Returns:

true if there was an external project with the given config path linked to the current ide project; false otherwise

setLinkedProjectsSettings

public void setLinkedProjectsSettings(java.util.Collection<? extends PS> settings)

checkSettings

protected abstract void checkSettings(PS old,
                                      PS current)

Is assumed to check if given old settings external system-specific state differs from the given new one and notify listeners in case of the positive answer.

Parameters:

old - old settings state

current - current settings state

getChangesTopic

public Topic<L> getChangesTopic()

getPublisher

public L getPublisher()

fillState

protected void fillState(AbstractExternalSystemSettings.State<PS> state)

loadState

protected void loadState(AbstractExternalSystemSettings.State<PS> state)