org.eclipse.core.commands.contexts

Class ContextManagerEvent

java.lang.Object

org.eclipse.core.commands.common.AbstractBitSetEvent

org.eclipse.core.commands.contexts.ContextManagerEvent

public final class ContextManagerEvent
extends AbstractBitSetEvent

An event indicating that the set of defined context identifiers has changed.

Since:

3.1

See Also:

IContextManagerListener.contextManagerChanged(ContextManagerEvent)

Field Summary

Fields inherited from class org.eclipse.core.commands.common.AbstractBitSetEvent

changedValues

Constructor Summary

Constructors

Constructor and Description
ContextManagerEvent(ContextManager contextManager, String contextId, boolean contextIdAdded, boolean activeContextsChanged, Set previouslyActiveContextIds) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
String	getContextId() Returns the context identifier that was added or removed.
ContextManager	getContextManager() Returns the instance of the interface that changed.
Set	getPreviouslyActiveContextIds() Returns the set of identifiers to previously active contexts.
boolean	isActiveContextsChanged() Returns whether the active context identifiers have changed.
boolean	isContextChanged() Returns whether the list of defined context identifiers has changed.
boolean	isContextDefined() Returns whether the context identifier became defined.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextManagerEvent

public ContextManagerEvent(ContextManager contextManager,
                           String contextId,
                           boolean contextIdAdded,
                           boolean activeContextsChanged,
                           Set previouslyActiveContextIds)

Creates a new instance of this class.

Parameters:

contextManager - the instance of the interface that changed; must not be null.

contextId - The context identifier that was added or removed; may be null if the active contexts are changing.

contextIdAdded - Whether the context identifier became defined (otherwise, it became undefined).

activeContextsChanged - Whether the list of active contexts has changed.

previouslyActiveContextIds - the set of identifiers of previously active contexts. This set may be empty. If this set is not empty, it must only contain instances of String. This set must be null if activeContextChanged is false and must not be null if activeContextChanged is true.

Method Detail

getContextId

public final String getContextId()

Returns the context identifier that was added or removed.

Returns:

The context identifier that was added or removed. This value may be null if no context identifier was added or removed.

getContextManager

public final ContextManager getContextManager()

Returns the instance of the interface that changed.

Returns:

the instance of the interface that changed. Guaranteed not to be null.

getPreviouslyActiveContextIds

public final Set getPreviouslyActiveContextIds()

Returns the set of identifiers to previously active contexts.

Returns:

the set of identifiers to previously active contexts. This set may be empty. If this set is not empty, it is guaranteed to only contain instances of String. This set is guaranteed to be null if haveActiveContextChanged() is false and is guaranteed to not be null if haveActiveContextsChanged() is true.

isActiveContextsChanged

public final boolean isActiveContextsChanged()

Returns whether the active context identifiers have changed.

Returns:

true if the collection of active contexts changed; false otherwise.

isContextChanged

public final boolean isContextChanged()

Returns whether the list of defined context identifiers has changed.

Returns:

true if the list of context identifiers has changed; false otherwise.

isContextDefined

public final boolean isContextDefined()

Returns whether the context identifier became defined. Otherwise, the context identifier became undefined.

Returns:

true if the context identifier became defined; false if the context identifier became undefined.