Package jetbrains.buildServer.serverSide

Interface ChangesCalculationOptionsEx

All Superinterfaces:

ChangesCalculationOptions

All Known Implementing Classes:

ChangesCalculationOptionsImpl

public interface ChangesCalculationOptionsEx
extends ChangesCalculationOptions

Method Summary

Modifier and Type	Method	Description
ChangesCalculationOptionsEx	copy()	Returns a new copy of this object which can be changed independently from the original
VcsModificationProcessor	getCallback()	Returns callback to invoke on computed changes
DefaultBranchChangesMode	getDefaultBranchChangesMode()	Returns custom default branch changes mode to use or null if mode configured in buildType should be used.
Date	getDetachedRootsChangesMinRegistrationDate()
PreviousBuildsProvider	getPreviousBuildsProvider()
Boolean	getShowSettingsChanges()	Returns true if settings changes should be shown, false if they should not be shown (even if enabled in versioned settings config), null if option from versioned settings config should be used
Boolean	isIncludeUnreachableChangesFromDetachedRoots()
ChangesCalculationOptionsEx	setCallback(VcsModificationProcessor callback)	Sets the callback to invoke on computed changes
ChangesCalculationOptionsEx	setDefaultBranchChangesMode(DefaultBranchChangesMode defaultBranchChangesMode)	Sets custom default branch changes mode to use, null means - use the mode configured in the buildType
void	setDetachedRootsChangesMinRegistrationDate(Date registrationDate)	Sets the minimal VCS modification registration date (commits registered before this date won't be returned).
ChangesCalculationOptionsEx	setIncludeDependencyChanges(Boolean includeDependencyChanges)	Specifies whether changes from snapshot dependencies should be computed.
ChangesCalculationOptionsEx	setIncludeUnreachableChangesFromDetachedRoots(Boolean showUnreachable)
ChangesCalculationOptionsEx	setPrevBuildPolicy(SelectPrevBuildPolicy prevBuildPolicy)	Sets previous build selection policy to use during changes calculation.
ChangesCalculationOptionsEx	setPreviousBuildsProvider(PreviousBuildsProvider previousBuildsProvider)	Sets custom provider of previous builds, this overwrites the effect of setPrevBuildPolicy(SelectPrevBuildPolicy) if it was called before.
ChangesCalculationOptionsEx	setReturnChangesIfNoPreviousBuildFound(boolean returnChangesIfNoPreviousBuildFound)	Specifies whether changes should be return when previous build is not found, by default true.
ChangesCalculationOptionsEx	setShowSettingsChanges(Boolean showSettingsChanges)	Specifies whether settings changes should be shown.

Methods inherited from interface jetbrains.buildServer.serverSide.ChangesCalculationOptions

getIncludeDependencyChanges, getPrevBuildPolicy, isReturnChangesIfNoPreviousBuildFound

Method Detail

getCallback

@NotNull
VcsModificationProcessor getCallback()

Returns callback to invoke on computed changes

Returns:

see above

setCallback

@NotNull
ChangesCalculationOptionsEx setCallback(@NotNull
                                        VcsModificationProcessor callback)

Sets the callback to invoke on computed changes

Parameters:

callback - callback

Returns:

this object

getDefaultBranchChangesMode

@Nullable
DefaultBranchChangesMode getDefaultBranchChangesMode()

Returns custom default branch changes mode to use or null if mode configured in buildType should be used.

Returns:

see above

setDefaultBranchChangesMode

@NotNull
ChangesCalculationOptionsEx setDefaultBranchChangesMode(@Nullable
                                                        DefaultBranchChangesMode defaultBranchChangesMode)

Sets custom default branch changes mode to use, null means - use the mode configured in the buildType

Parameters:

defaultBranchChangesMode - changes mode to use

Returns:

this object

setPreviousBuildsProvider

@NotNull
ChangesCalculationOptionsEx setPreviousBuildsProvider(@NotNull
                                                      PreviousBuildsProvider previousBuildsProvider)

Sets custom provider of previous builds, this overwrites the effect of setPrevBuildPolicy(SelectPrevBuildPolicy) if it was called before.

Parameters:

previousBuildsProvider -

Returns:

this object

getShowSettingsChanges

@Nullable
Boolean getShowSettingsChanges()

Returns true if settings changes should be shown, false if they should not be shown (even if enabled in versioned settings config), null if option from versioned settings config should be used

Returns:

see above

isIncludeUnreachableChangesFromDetachedRoots

@Nullable
Boolean isIncludeUnreachableChangesFromDetachedRoots()

getPreviousBuildsProvider

@NotNull
PreviousBuildsProvider getPreviousBuildsProvider()

setShowSettingsChanges

@NotNull
ChangesCalculationOptionsEx setShowSettingsChanges(@Nullable
                                                   Boolean showSettingsChanges)

Specifies whether settings changes should be shown. Null means use option specified in versioned settings configuration.

Parameters:

showSettingsChanges - whether the settings changes should be shown

Returns:

this object

copy

@NotNull
ChangesCalculationOptionsEx copy()

Description copied from interface: ChangesCalculationOptions

Returns a new copy of this object which can be changed independently from the original

Specified by:

copy in interface ChangesCalculationOptions

Returns:

see above

setPrevBuildPolicy

@NotNull
ChangesCalculationOptionsEx setPrevBuildPolicy(@NotNull
                                               SelectPrevBuildPolicy prevBuildPolicy)

Description copied from interface: ChangesCalculationOptions

Sets previous build selection policy to use during changes calculation. If not specified, then the SelectPrevBuildPolicy.SINCE_LAST_BUILD policy is used.

Specified by:

setPrevBuildPolicy in interface ChangesCalculationOptions

Parameters:

prevBuildPolicy - policy to use

Returns:

options object

setReturnChangesIfNoPreviousBuildFound

@NotNull
ChangesCalculationOptionsEx setReturnChangesIfNoPreviousBuildFound(boolean returnChangesIfNoPreviousBuildFound)

Description copied from interface: ChangesCalculationOptions

Specifies whether changes should be return when previous build is not found, by default true. If set to false and previous build is not found, then changes calculation will return an empty collection of changes.

Specified by:

setReturnChangesIfNoPreviousBuildFound in interface ChangesCalculationOptions

Parameters:

returnChangesIfNoPreviousBuildFound - whether changes should be computed

Returns:

this object

setIncludeDependencyChanges

ChangesCalculationOptionsEx setIncludeDependencyChanges(@Nullable
                                                        Boolean includeDependencyChanges)

Description copied from interface: ChangesCalculationOptions

Specifies whether changes from snapshot dependencies should be computed. Null means use option specified in build configuration.

Specified by:

setIncludeDependencyChanges in interface ChangesCalculationOptions

Parameters:

includeDependencyChanges - whether changes from dependencies should be computed

Returns:

this object

setIncludeUnreachableChangesFromDetachedRoots

@NotNull
ChangesCalculationOptionsEx setIncludeUnreachableChangesFromDetachedRoots(@Nullable
                                                                          Boolean showUnreachable)

setDetachedRootsChangesMinRegistrationDate

void setDetachedRootsChangesMinRegistrationDate(@NotNull
                                                Date registrationDate)

Sets the minimal VCS modification registration date (commits registered before this date won't be returned).

Parameters:

registrationDate -

getDetachedRootsChangesMinRegistrationDate

@Nullable
Date getDetachedRootsChangesMinRegistrationDate()