Package jenkins.scm.api

Enum SCMEvent.Type

java.lang.Object

java.lang.Enum<SCMEvent.Type>

jenkins.scm.api.SCMEvent.Type

All Implemented Interfaces:

Serializable, Comparable<SCMEvent.Type>

Enclosing class:

SCMEvent<P>

public static enum SCMEvent.Type
extends Enum<SCMEvent.Type>

The type of event.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CREATED	Signifies the creation of a new thing: An existing SCMNavigator getting a new SCMSource would trigger a SCMSourceEvent An existing SCMSource getting a new SCMHead would trigger a SCMHeadEvent
REMOVED	Signifies the removal of an existing thing: An existing SCMNavigator being removed would trigger a SCMNavigatorEvent An existing SCMSource being removed would trigger a SCMSourceEvent An existing SCMHead being removed would trigger a SCMHeadEvent
UPDATED	Signifies the update of metadata of existing thing: An existing SCMNavigator's metadata changing would trigger a SCMNavigatorEvent An existing SCMSource's metadata changing would trigger a SCMSourceEvent An existing SCMHead's metadata changing (including the SCMRevision that the SCMHead points to) would trigger a SCMHeadEvent

Method Summary

Modifier and Type	Method	Description
static SCMEvent.Type	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SCMEvent.Type[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CREATED

public static final SCMEvent.Type CREATED

Signifies the creation of a new thing:

• An existing SCMNavigator getting a new SCMSource would trigger a SCMSourceEvent
• An existing SCMSource getting a new SCMHead would trigger a SCMHeadEvent

UPDATED

public static final SCMEvent.Type UPDATED

Signifies the update of metadata of existing thing:

• An existing SCMNavigator's metadata changing would trigger a SCMNavigatorEvent
• An existing SCMSource's metadata changing would trigger a SCMSourceEvent
• An existing SCMHead's metadata changing (including the SCMRevision that the SCMHead points to) would trigger a SCMHeadEvent

REMOVED

public static final SCMEvent.Type REMOVED

Signifies the removal of an existing thing:

• An existing SCMNavigator being removed would trigger a SCMNavigatorEvent
• An existing SCMSource being removed would trigger a SCMSourceEvent
• An existing SCMHead being removed would trigger a SCMHeadEvent

Method Detail

values

public static SCMEvent.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SCMEvent.Type c : SCMEvent.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SCMEvent.Type valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null