hudson.scm
Enum PollingResult.Change

java.lang.Object
  java.lang.Enum<PollingResult.Change>
      hudson.scm.PollingResult.Change

All Implemented Interfaces:

Serializable, Comparable<PollingResult.Change>

Enclosing class:

PollingResult

public static enum PollingResult.Change
extends Enum<PollingResult.Change>

Degree of changes between the previous state and this state.

Enum Constant Summary

INCOMPARABLE
The state as of baseline is so different from the current state that they are incomparable (for example, the workspace and the remote repository points to two unrelated repositories because the configuration has changed.) This forces Jenkins to schedule a build right away.

INSIGNIFICANT
There are some changes between states, but those changes are not significant enough to consider a new build.

NONE
No change.

SIGNIFICANT
There are changes between states that warrant a new build.

Method Summary

static PollingResult.Change	valueOf(String name) Returns the enum constant of this type with the specified name.
static PollingResult.Change[]	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

NONE

public static final PollingResult.Change NONE

No change. Two SCMRevisionStates point to the same state of the same repository / the same commit.

INSIGNIFICANT

public static final PollingResult.Change INSIGNIFICANT

There are some changes between states, but those changes are not significant enough to consider a new build. For example, some SCMs allow certain commits to be marked as excluded, and this is how you can do it.

SIGNIFICANT

public static final PollingResult.Change SIGNIFICANT

There are changes between states that warrant a new build. Jenkins will eventually schedule a new build for this change, subject to other considerations such as the quiet period.

INCOMPARABLE

public static final PollingResult.Change INCOMPARABLE

The state as of baseline is so different from the current state that they are incomparable (for example, the workspace and the remote repository points to two unrelated repositories because the configuration has changed.) This forces Jenkins to schedule a build right away.

This is primarily useful in SCM implementations that require a workspace to be able to perform a polling. SCMs that can always compare remote revisions regardless of the local state should do so, and never return this constant, to let Jenkins maintain the quiet period behavior all the time.

This constant is not to be confused with the errors encountered during polling, which should result in an exception and eventual retry by Jenkins.

Method Detail

values

public static PollingResult.Change[] 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 (PollingResult.Change c : PollingResult.Change.values())
    System.out.println(c);

Returns:

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

valueOf

public static PollingResult.Change 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