com.atlassian.plugin.event.events

Class PluginTransactionEndEvent

java.lang.Object

com.atlassian.plugin.event.events.PluginTransactionEndEvent

@PublicApi
public class PluginTransactionEndEvent
extends Object

Event send at the end of an action wrapping existing plugin events:

• PluginEnablingEvent
• PluginEnabledEvent
• PluginDisablingEvent
• PluginDisabledEvent
• PluginModuleDisablingEvent
• PluginModuleDisabledEvent
• PluginModuleEnablingEvent
• PluginModuleEnabledEvent
• PluginRefreshedEvent
• PluginFrameworkStartingEvent
• PluginFrameworkDelayedEvent
• PluginFrameworkResumingEvent
• PluginFrameworkStartedEvent
• PluginFrameworkShuttingDownEvent
• PluginFrameworkShutdownEvent
• PluginFrameworkWarmRestartingEvent
• PluginFrameworkWarmRestartedEvent
• PluginUninstallingEvent
• PluginUninstalledEvent
• PluginInstallingEvent
• PluginInstalledEvent
• PluginUpgradingEvent
• PluginUpgradedEvent
• PluginDependentsChangedEvent

Contains information about plugin events which were part of this transaction.

Since:

5.1.3

See Also:

com.atlassian.plugin.event.events

Constructor Summary

Constructors

Constructor and Description
PluginTransactionEndEvent(List<Object> events)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableList<Object>	getEvents() Deprecated. This is deprecated since 5.6.0. Please migrate code to use getUnmodifiableEvents() instead, this will be removed in the next major release of Atlassian Plugins.
List<Object>	getUnmodifiableEvents()
<T> boolean	hasAnyEventOfTypeMatching(Class<T> eventTypeClass, Predicate<T> anyMatchEventPredicate) Returns true if any event of type eventTypeClass matching anyMatchEventPredicate was part of this transaction.
boolean	hasAnyEventWithModuleDescriptorMatching(Predicate<ModuleDescriptor<?>> anyMatchModuleDescriptorPredicate) Returns true if any event of type PluginModuleEvent with PluginModuleEvent.getModule() matching anyMatchModuleDescriptorPredicate was part of this transaction, or if any event of type PluginEvent with PluginEvent.getPlugin() with any Plugin.getModuleDescriptors() matching anyMatchModuleDescriptorPredicate was part of this transaction.
int	numberOfEvents()
long	threadId()

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginTransactionEndEvent

public PluginTransactionEndEvent(List<Object> events)

Method Detail

getEvents

@Deprecated
public com.google.common.collect.ImmutableList<Object> getEvents()

Deprecated. This is deprecated since 5.6.0. Please migrate code to use getUnmodifiableEvents() instead, this will be removed in the next major release of Atlassian Plugins.

Returns:

an ImmutableList of events

getUnmodifiableEvents

public List<Object> getUnmodifiableEvents()

Returns:

an unmodifiable list of events.

Since:

5.6.0.

numberOfEvents

public int numberOfEvents()

hasAnyEventOfTypeMatching

public <T> boolean hasAnyEventOfTypeMatching(Class<T> eventTypeClass,
                                             Predicate<T> anyMatchEventPredicate)

Returns true if any event of type eventTypeClass matching anyMatchEventPredicate was part of this transaction.

hasAnyEventWithModuleDescriptorMatching

public boolean hasAnyEventWithModuleDescriptorMatching(Predicate<ModuleDescriptor<?>> anyMatchModuleDescriptorPredicate)

Returns true if any event of type PluginModuleEvent with PluginModuleEvent.getModule() matching anyMatchModuleDescriptorPredicate was part of this transaction, or if any event of type PluginEvent with PluginEvent.getPlugin() with any Plugin.getModuleDescriptors() matching anyMatchModuleDescriptorPredicate was part of this transaction.

threadId

public long threadId()

Returns:

thread ID of the thread sending this event; can be used to match PluginTransactionStartEvent and PluginTransactionEndEvent