jenkins.scm.api.mixin

Class ChangeRequestSCMRevision<H extends SCMHead & ChangeRequestSCMHead>

java.lang.Object

jenkins.scm.api.SCMRevision

jenkins.scm.api.mixin.ChangeRequestSCMRevision<H>

All Implemented Interfaces:

Serializable

public abstract class ChangeRequestSCMRevision<H extends SCMHead & ChangeRequestSCMHead>
extends SCMRevision

Recommended base class for the SCMRevision of a ChangeRequestSCMHead.

Since:

2.2.0

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChangeRequestSCMRevision(H head, SCMRevision target) Constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract int	_hashCode() Compute the hashCode() excluding getTarget().
boolean	equals(Object o)
abstract boolean	equivalent(ChangeRequestSCMRevision<?> revision) Performs an equality comparison as for equals(Object) but excludes the getTarget() SCMRevision from the comparison (though the ChangeRequestSCMHead.getTarget() will be included as part of the SCMRevision.getHead() comparison.
SCMRevision	getTarget() Returns the revision of the ChangeRequestSCMHead.getTarget() that this ChangeRequestSCMHead is associated with.
int	hashCode()
boolean	isMerge() Is this a ChangeRequestSCMRevision that will be merged on top of getTarget()?

Methods inherited from class jenkins.scm.api.SCMRevision

getHead, isDeterministic, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeRequestSCMRevision

protected ChangeRequestSCMRevision(@NonNull
                                   H head,
                                   @NonNull
                                   SCMRevision target)

Constructor.

Parameters:

head - the SCMHead that the SCMRevision belongs to.

target - the SCMRevision of the ChangeRequestSCMHead.getTarget().

Method Detail

getTarget

@Exported
 @NonNull
public final SCMRevision getTarget()

Returns the revision of the ChangeRequestSCMHead.getTarget() that this ChangeRequestSCMHead is associated with.

Returns:

a "target" or "base" branch revision.

isMerge

@Exported
public final boolean isMerge()

Is this a ChangeRequestSCMRevision that will be merged on top of getTarget()?

Returns:

true if the effective revision is the result of merging onto the getTarget() revision false if the effective revision ignores the getTarget().

See Also:

ChangeRequestSCMHead2

equivalent

public abstract boolean equivalent(ChangeRequestSCMRevision<?> revision)

Performs an equality comparison as for equals(Object) but excludes the getTarget() SCMRevision from the comparison (though the ChangeRequestSCMHead.getTarget() will be included as part of the SCMRevision.getHead() comparison.

Parameters:

revision - the revision to compare with.

Returns:

true if equal to supplied revision (ignoring differences in getTarget())

_hashCode

protected abstract int _hashCode()

Compute the hashCode() excluding getTarget().

Returns:

a hash code value for this object.

equals

public final boolean equals(Object o)

Specified by:

equals in class SCMRevision

hashCode

public final int hashCode()

Specified by:

hashCode in class SCMRevision