Package com.atlassian.bamboo.cluster.event.plugin

Class AbstractPluginEvent<R>

java.lang.Object

com.atlassian.bamboo.cluster.event.AbstractCrossNodesEvent<R>

com.atlassian.bamboo.cluster.event.plugin.AbstractPluginEvent<R>

Type Parameters:

R - the correspondent CrossNodesCommunication event type

All Implemented Interfaces:

CrossNodesEvent, Serializable

Direct Known Subclasses:

DisablePluginEvent, EnablePluginEvent, InstallPluginEvent, UninstallPluginEvent, UpgradePluginEvent

public abstract class AbstractPluginEvent<R>
extends AbstractCrossNodesEvent<R>
implements CrossNodesEvent, Serializable

Abstract class with commonalities for plugin events.

Child classes need to expose their own static method to create a Builder. For instance, take a look at InstallPluginEvent.newBuilder().

Since:

9.5

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractPluginEvent.AbstractPluginEventBuilder<T extends AbstractPluginEvent<?>,B extends AbstractPluginEvent.AbstractPluginEventBuilder<T,B>>

Nested classes/interfaces inherited from interface com.atlassian.bamboo.cluster.event.CrossNodesEvent

CrossNodesEvent.Type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPluginEvent(CrossNodesEvent.Type eventType, String pluginKey, int pluginsVersion, String pluginName)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull CrossNodesEvent.Type	getType()	Returns the type of the event.
int	hashCode()	Returns a hash code value for the object.
boolean	isEmpty()	Returns whether the event is empty.
R	toGrpcRequestMessage(@NotNull MetadataInfo metadataInfo)
protected abstract R	toGrpcRequestMessage(@NotNull MetadataInfo metadataInfo, String pluginKey, int pluginsVersion, String pluginName)
@NotNull String	toString()	Returns a string representation of the object.

Methods inherited from class com.atlassian.bamboo.cluster.event.AbstractCrossNodesEvent

send

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.bamboo.cluster.event.CrossNodesEvent

isNotEmpty

Constructor Detail

AbstractPluginEvent

protected AbstractPluginEvent(@NotNull
                              CrossNodesEvent.Type eventType,
                              String pluginKey,
                              int pluginsVersion,
                              String pluginName)

Method Detail

getType

@NotNull
public @NotNull CrossNodesEvent.Type getType()

Description copied from interface: CrossNodesEvent

Returns the type of the event.

Specified by:

getType in interface CrossNodesEvent

Returns:

the type of the event

isEmpty

public boolean isEmpty()

Description copied from interface: CrossNodesEvent

Returns whether the event is empty. May be needed to avoid sending empty events.

Specified by:

isEmpty in interface CrossNodesEvent

Returns:

true if the event is empty, false otherwise.

toString

@NotNull
public @NotNull String toString()

Description copied from interface: CrossNodesEvent

Returns a string representation of the object.

Specified by:

toString in interface CrossNodesEvent

Overrides:

toString in class Object

Returns:

a string representation of the object

equals

public boolean equals(Object o)

Description copied from interface: CrossNodesEvent

Indicates whether some other object is "equal to" this one.

Specified by:

equals in interface CrossNodesEvent

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare

Returns:

true if this object is the same as the obj argument; false otherwise

hashCode

public int hashCode()

Description copied from interface: CrossNodesEvent

Returns a hash code value for the object.

Specified by:

hashCode in interface CrossNodesEvent

Overrides:

hashCode in class Object

Returns:

a hash code value for this object

toGrpcRequestMessage

@NotNull
protected abstract R toGrpcRequestMessage(@NotNull
                                          @NotNull MetadataInfo metadataInfo,
                                          String pluginKey,
                                          int pluginsVersion,
                                          String pluginName)

toGrpcRequestMessage

@NotNull
public R toGrpcRequestMessage(@NotNull
                              @NotNull MetadataInfo metadataInfo)

Specified by:

toGrpcRequestMessage in class AbstractCrossNodesEvent<R>