org.argouml.application.api
Interface ArgoSingletonModule

All Superinterfaces:

ArgoModule

public interface ArgoSingletonModule

extends ArgoModule

An interface which identifies an ArgoUML plug-in which behaves as a singleton, but may be swapped with another plugin singleton of the same type. Only one singleton module can be considered active at the same time.

Since:

0.9.4

canActivateSingleton

public boolean canActivateSingleton()

Deprecated. 

Allows verification that the current singleton can be activated. This is useful for determining menu entry availability, among other things.

Returns:

true if the singleton can be activated false otherwise.

canDeactivateSingleton

public boolean canDeactivateSingleton()

Deprecated. 

Allows verification that the current singleton can be deactivated. This is useful for determining menu entry availability, among other things.

Returns:

true if the singleton can be deactivated false otherwise.

deactivateSingleton

public void deactivateSingleton()

Deprecated. 

Callback by which the active singleton is notified that it is being deactivated. This is called prior to calling activateSingleton() on the new singleton. After the call to deactivateSingleton() and before the call to activateSingleton(), the previously active singleton is considered to be the active singleton even though it is not marked as active.

activateSingleton

public void activateSingleton()

Deprecated. 

Callback by which the singleton being activated is notified that it is being activated. This is called after calling deactivateSingleton() on the previous singleton.

getSingletonType

public Class getSingletonType()

Deprecated. 

TODO: Document this.

Returns:

class which identifies the singleton