public class

ScmStatusChangedEvent

extends ScmEvent
java.lang.Object
   ↳ java.util.EventObject
     ↳ com.atlassian.bitbucket.scm.event.ScmEvent
       ↳ com.atlassian.bitbucket.scm.event.ScmStatusChangedEvent

Class Overview

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

Summary

[Expand]
Inherited Fields
From class java.util.EventObject
Public Constructors
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.
Public Methods
@Nonnull ScmStatus getPreviousStatus()
Retrieves the previous status for the SCM.
[Expand]
Inherited Methods
From class com.atlassian.bitbucket.scm.event.ScmEvent
From class java.util.EventObject
From class java.lang.Object

Public Constructors

public 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. 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

Public Methods

@Nonnull public ScmStatus getPreviousStatus ()

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

Returns
  • the previous status for the SCM