com.atlassian.bitbucket.scm.event

Class ScmEvent

java.lang.Object

java.util.EventObject

com.atlassian.bitbucket.scm.event.ScmEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ScmStatusChangedEvent

public abstract class ScmEvent
extends EventObject

Common base for all events raised by SCM implementations.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ScmEvent(Object source, Scm scm) Constructs a new ScmEvent, initialising the event's source and setting the Scm from which the event is being raised.

Method Summary

Modifier and Type	Method and Description
Scm	getScm() Retrieves the Scm raising the event.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ScmEvent

public ScmEvent(@Nonnull
                Object source,
                @Nonnull
                Scm scm)

Constructs a new ScmEvent, initialising the event's source and setting the Scm from which the event is being raised.

Parameters:

source - the component within the SCM raising the event

scm - the SCM raising the event

Throws:

NullPointerException - if source or scm is null

Method Detail

getScm

@Nonnull
public Scm getScm()

Retrieves the Scm raising the event.

Note: This may not match the getSource() value, which could be a component within the SCM rather than the Scm itself.

Returns:

the SCM