jenkins.scm.api

Class SCMNavigatorEvent<P>

java.lang.Object

jenkins.scm.api.SCMEvent<P>

jenkins.scm.api.SCMNavigatorEvent<P>

Type Parameters:

P - the (provider specific) payload.

public abstract class SCMNavigatorEvent<P>
extends SCMEvent<P>

Base class for events relating to SCMNavigator instances.

Since:

2.0

Nested Class Summary

Nested classes/interfaces inherited from class jenkins.scm.api.SCMEvent

SCMEvent.Dispatcher<E extends SCMEvent<?>>, SCMEvent.EventQueueMetrics, SCMEvent.Type

Field Summary

Fields inherited from class jenkins.scm.api.SCMEvent

ORIGIN_UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
	SCMNavigatorEvent(SCMEvent.Type type, long timestamp, P payload) Deprecated.
	SCMNavigatorEvent(SCMEvent.Type type, long timestamp, P payload, String origin)
	SCMNavigatorEvent(SCMEvent.Type type, P payload) Deprecated.
	SCMNavigatorEvent(SCMEvent.Type type, P payload, String origin)
protected	SCMNavigatorEvent(SCMNavigatorEvent<P> src)

Method Summary

Modifier and Type	Method and Description
String	descriptionFor(SCMNavigator navigator) Return a description of the event in the context of the supplied SCMNavigator.
static void	fireLater(SCMNavigatorEvent<?> event, long delay, TimeUnit delayUnits) Fires the SCMNavigatorEvent to all registered SCMEventListener instances after the specified delay.
static void	fireNow(SCMNavigatorEvent<?> event) Fires the SCMNavigatorEvent to all registered SCMEventListener instances.
abstract boolean	isMatch(SCMNavigator navigator) Tests if this event applies to the supplied SCMNavigator.

Methods inherited from class jenkins.scm.api.SCMEvent

asCauses, closeExecutorService, description, equals, executorService, getDate, getEventProcessingMetrics, getOrigin, getPayload, getTimestamp, getType, hashCode, originOf, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMNavigatorEvent

@Deprecated
public SCMNavigatorEvent(@NonNull
                                     SCMEvent.Type type,
                                     long timestamp,
                                     @NonNull
                                     P payload)

Deprecated.

SCMNavigatorEvent

public SCMNavigatorEvent(@NonNull
                         SCMEvent.Type type,
                         long timestamp,
                         @NonNull
                         P payload,
                         @CheckForNull
                         String origin)

SCMNavigatorEvent

@Deprecated
public SCMNavigatorEvent(@NonNull
                                     SCMEvent.Type type,
                                     @NonNull
                                     P payload)

Deprecated.

SCMNavigatorEvent

public SCMNavigatorEvent(@NonNull
                         SCMEvent.Type type,
                         @NonNull
                         P payload,
                         @CheckForNull
                         String origin)

SCMNavigatorEvent

protected SCMNavigatorEvent(@NonNull
                            SCMNavigatorEvent<P> src)

Method Detail

isMatch

public abstract boolean isMatch(SCMNavigator navigator)

Tests if this event applies to the supplied SCMNavigator.

Parameters:

navigator - the SCMNavigator.

Returns:

true if and only if this event concerns the supplied SCMNavigator.

descriptionFor

@CheckForNull
public String descriptionFor(SCMNavigator navigator)

Return a description of the event in the context of the supplied SCMNavigator.

Parameters:

navigator - the SCMNavigator, the navigator must be isMatch(SCMNavigator).

Returns:

the description or null if no description can be provided.

Since:

2.1.1

fireNow

public static void fireNow(@NonNull
                           SCMNavigatorEvent<?> event)

Fires the SCMNavigatorEvent to all registered SCMEventListener instances.

Parameters:

event - the event to fire.

fireLater

public static void fireLater(@NonNull
                             SCMNavigatorEvent<?> event,
                             long delay,
                             TimeUnit delayUnits)

Fires the SCMNavigatorEvent to all registered SCMEventListener instances after the specified delay.

Parameters:

event - the event to fire.

delay - how long to wait before firing the event.

delayUnits - the units of time in which the delay is expressed.