com.atlassian.bitbucket.scm.event

Class ScmStatusChangedEvent

java.lang.Object

java.util.EventObject

com.atlassian.bitbucket.scm.event.ScmEvent

com.atlassian.bitbucket.scm.event.ScmStatusChangedEvent

All Implemented Interfaces:

Serializable

public class ScmStatusChangedEvent
extends ScmEvent

Raised when the status of an SCM changes at runtime.

When an SCM determines its initial status, it should not raise this event. Instead, this should only be raised when something causes the plugin's SCM status to change after it has already started. For example, if an SCM starts out as unavailable because required SCM files have not been installed and a system administrator installs those files, the SCM may detect the change and update its status accordingly.

Note: This event is an optimisation. SCMs are not required to support changing their status at runtime.

See Also:

Scm.getStatus(), Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ScmStatusChangedEvent(Object source, Scm scm, ScmStatus previousStatus) Constructs a new ScmStatusChangedEvent, initialising the source and setting the Scm whose status has changed and the status the SCM used to have.

Method Summary

Modifier and Type	Method and Description
ScmStatus	getPreviousStatus() Retrieves the previous status for the SCM.

Methods inherited from class com.atlassian.bitbucket.scm.event.ScmEvent

getScm

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

ScmStatusChangedEvent

public ScmStatusChangedEvent(@Nonnull
                             Object source,
                             @Nonnull
                             Scm scm,
                             @Nonnull
                             ScmStatus previousStatus)

Constructs a new ScmStatusChangedEvent, initialising the source and setting the Scm whose status has changed and the status the SCM used to have. The previousStatus is required, to allow event listeners to determine when the availability of an SCM changes.

Parameters:

source - the component within the SCM raising the event

scm - the SCM whose status has changed, used to retrieve the current status

previousStatus - the status the SCM used to have

Throws:

NullPointerException - if the source, scm or previousStatus is null

Method Detail

getPreviousStatus

@Nonnull
public ScmStatus getPreviousStatus()

Retrieves the previous status for the SCM. The current status may be retrieved using ScmEvent.getScm().getStatus().

Returns:

the previous status for the SCM