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.
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.
|
|
[Expand]
Inherited Methods |
From class
com.atlassian.stash.scm.event.ScmEvent
|
From class
java.util.EventObject
|
Object
|
getSource()
|
|
String
|
toString()
|
|
From class
java.lang.Object
|
Object
|
clone()
|
|
boolean
|
equals(Object arg0)
|
|
void
|
finalize()
|
|
final
Class<?>
|
getClass()
|
|
int
|
hashCode()
|
|
final
void
|
notify()
|
|
final
void
|
notifyAll()
|
|
String
|
toString()
|
|
final
void
|
wait()
|
|
final
void
|
wait(long arg0, int arg1)
|
|
final
void
|
wait(long arg0)
|
|
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
()
Returns
- the previous status for the SCM