Table of Contents

Interface IIssuesSetDiff

Namespace
NDepend.Issue
Assembly
NDepend.API.dll

An issues-set-diff compares its NewerIssuesSet and OlderIssuesSet objects and makes convenient to browse diff information about issues, rule and code elements of these two issues sets.

public interface IIssuesSetDiff
Extension Methods

Remarks

An issues-set-diff can be created through CreateIssuesSetDiff(ICompareContext, IIssuesSet, IIssuesSet) or ComputeIssuesDiff(IAnalysisResult, ICompareContext).
An issues-set-diff gets filled through methods of IIssuesSetDiffBuilder available through Builder.
An issues-set-diff is not thread-safe. It is safe to call IIssuesSetDiff read-only methods concurrently from several threads but it is not safe to call these methods and IIssuesSetBuilder methods concurrently from several threads, this would provoke corrupted state and exceptions.
When an IIssuesSetDiff object compares two IIssuesSet objects, the IIssuesSet objects are not modified nor aware they are compared. As a consequence an IIssuesSet object can be compared in several IIssuesSetDiff object.

Properties (10)

AllAnnualInterestDiff

Gets NewerIssuesSet.AllAnnualInterest minus OlderIssuesSet.AllAnnualInterest.

AnnualInterest AllAnnualInterestDiff { get; }

Property Value

AnnualInterest

Remarks

The result can be a positive, zero or negative AnnualInterest value.

AllAnnualInterestPercentDiff

Gets ExtensionMethodsDebtUsableInCQLinq.AnnualInterestPercent(Debt, AnnualInterest)(AllDebtDiff,AllAnnualInterestDiff).

double AllAnnualInterestPercentDiff { get; }

Property Value

double

Remarks

The result can be a positive, zero or negative value.

AllBreakingPointDiff

Gets ExtensionMethodsDebtUsableInCQLinq.BreakingPoint(Debt, AnnualInterest)(AllDebtDiff,AllAnnualInterestDiff).

TimeSpan AllBreakingPointDiff { get; }

Property Value

TimeSpan

Remarks

The result can be a positive, zero or negative TimeSpan value.

AllDebtDiff

Gets NewerIssuesSet.AllDebt minus OlderIssuesSet.AllDebt.

Debt AllDebtDiff { get; }

Property Value

Debt

Remarks

The result can be a positive, zero or negative Debt value.

AllIssuesAdded

Gets all issues of NewerIssuesSet that have no equivalent in OlderIssuesSet. These issues are considered as added.

IEnumerable<IIssue> AllIssuesAdded { get; }

Property Value

IEnumerable<IIssue>

Remarks

The issues of NewerIssuesSet and OlderIssuesSet are paired when they share the same Rule and the same CodeElement.

AllIssuesFixed

Gets all issues of OlderIssuesSet that have no equivalent in NewerIssuesSet. These issues are considered as added.

IEnumerable<IIssue> AllIssuesFixed { get; }

Property Value

IEnumerable<IIssue>

Remarks

The issues of NewerIssuesSet and OlderIssuesSet are paired when they share the same Rule and the same CodeElement.

Builder

Gets the issues set builder, the only way to modify this issues set.

IIssuesSetDiffBuilder Builder { get; }

Property Value

IIssuesSetDiffBuilder

CompareContext

Gets the ICompareContext object used to compare NewerCodeBase and OlderCodeBase.

ICompareContext CompareContext { get; }

Property Value

ICompareContext

NewerIssuesSet

Gets the newer issues set of this issues-set-diff.

IIssuesSet NewerIssuesSet { get; }

Property Value

IIssuesSet

OlderIssuesSet

Gets the older issues set of this issues-set-diff.

IIssuesSet OlderIssuesSet { get; }

Property Value

IIssuesSet

Methods (48)

AllAnnualInterestDiffIn(ICodeElement)

Gets NewerIssuesSet.AllAnnualInterestIn(ICodeElement) of NewerVersion<T>(T) of codeElement, minus OlderIssuesSet.AllAnnualInterestIn(ICodeElement) of OlderVersion<T>(T) of codeElement.

AnnualInterest AllAnnualInterestDiffIn(ICodeElement codeElement)

Parameters

codeElement ICodeElement

The code element object can be the NewerVersion<T>(T) or OlderVersion<T>(T) of the same code element.

Returns

AnnualInterest

Remarks

If NewerVersion<T>(T) or OlderVersion<T>(T) of codeElement is null, AnnualInterest.Zero value is taken instead.
The returned AnnualInterest value can be positive, zero or negative.

Exceptions

ArgumentException

codeElement is not present in NewerIssuesSet nor OlderIssuesSet.

AllAnnualInterestPercentDiffIn(ICodeElement)

Gets ExtensionMethodsDebtUsableInCQLinq.AnnualInterestPercent(Debt, AnnualInterest)(AllDebtDiffIn(ICodeElement),AllAnnualInterestDiffIn(ICodeElement)).

double AllAnnualInterestPercentDiffIn(ICodeElement codeElement)

Parameters

codeElement ICodeElement

The code element object can be the NewerVersion<T>(T) or OlderVersion<T>(T) of the same code element.

Returns

double

Remarks

The returned value can be positive, zero or negative.

Exceptions

ArgumentException

codeElement is not present in NewerIssuesSet nor OlderIssuesSet.

AllBreakingPointDiffIn(ICodeElement)

Gets ExtensionMethodsDebtUsableInCQLinq.BreakingPoint(Debt, AnnualInterest)(AllDebtDiffIn(ICodeElement),AllAnnualInterestDiffIn(ICodeElement)).

TimeSpan AllBreakingPointDiffIn(ICodeElement codeElement)

Parameters

codeElement ICodeElement

The code element object can be the NewerVersion<T>(T) or OlderVersion<T>(T) of the same code element.

Returns

TimeSpan

Remarks

The returned TimeSpan value can be positive, zero or negative.

Exceptions

ArgumentException

codeElement is not present in NewerIssuesSet nor OlderIssuesSet.

AllDebtDiffIn(ICodeElement)

Gets NewerIssuesSet.AllDebtIn(ICodeElement) of NewerVersion<T>(T) of codeElement, minus OlderIssuesSet.AllDebtIn(ICodeElement) of OlderVersion<T>(T) of codeElement.

Debt AllDebtDiffIn(ICodeElement codeElement)

Parameters

codeElement ICodeElement

The code element object can be the NewerVersion<T>(T) or OlderVersion<T>(T) of the same code element.

Returns

Debt

Remarks

If NewerVersion<T>(T) or OlderVersion<T>(T) of codeElement is null, Debt.Zero value is taken instead.
The returned Debt value can be positive, zero or negative.

Exceptions

ArgumentException

codeElement is not present in NewerIssuesSet nor OlderIssuesSet.

AnnualInterestDiff(ICodeElement)

Gets NewerIssuesSet.AnnualInterest(ICodeElement) of NewerVersion<T>(T) of codeElement, minus OlderIssuesSet.AnnualInterest(ICodeElement) of OlderVersion<T>(T) of codeElement.

AnnualInterest AnnualInterestDiff(ICodeElement codeElement)

Parameters

codeElement ICodeElement

The code element object can be the NewerVersion<T>(T) or OlderVersion<T>(T) of the same code element.

Returns

AnnualInterest

Remarks

If NewerVersion<T>(T) or OlderVersion<T>(T) of codeElement is null, AnnualInterest.Zero value is taken instead.
The returned AnnualInterest value can be positive, zero or negative.

Exceptions

ArgumentException

codeElement is not present in NewerIssuesSet nor OlderIssuesSet.

AnnualInterestDiff(IIssue)

Gets NewerVersion(IIssue).AnnualInterest of issue, minus OlderVersion(IIssue).AnnualInterest of issue,

AnnualInterest AnnualInterestDiff(IIssue issue)

Parameters

issue IIssue

The issue object can be the NewerVersion(IIssue) or OlderVersion(IIssue) of the same issue.

Returns

AnnualInterest

Remarks

If NewerVersion(IIssue) or OlderVersion(IIssue) of issue is null, AnnualInterest.Zero value is taken instead.
The returned AnnualInterest value can be positive, zero or negative.

Exceptions

ArgumentException

issue is not present in NewerIssuesSet nor OlderIssuesSet.

AnnualInterestDiff(IRule)

Gets NewerIssuesSet.AnnualInterest(IRule) of NewerVersion(IRule) of rule, minus OlderIssuesSet.AnnualInterest(IRule) of OlderVersion(IRule) of rule.

AnnualInterest AnnualInterestDiff(IRule rule)

Parameters

rule IRule

The rule object can be the NewerVersion(IRule) or OlderVersion(IRule) of the same rule.

Returns

AnnualInterest

Remarks

If NewerVersion(IRule) or OlderVersion(IRule) of rule is null, Debt.Zero value is taken instead.
The returned AnnualInterest value can be positive, zero or negative.

Exceptions

ArgumentException

rule is not present in NewerIssuesSet nor OlderIssuesSet.

AnnualInterestPercentDiff(ICodeElement)

Gets ExtensionMethodsDebtUsableInCQLinq.AnnualInterestPercent(Debt, AnnualInterest)(DebtDiff(ICodeElement),AnnualInterestDiff(ICodeElement)).

double AnnualInterestPercentDiff(ICodeElement codeElement)

Parameters

codeElement ICodeElement

The code element object can be the NewerVersion<T>(T) or OlderVersion<T>(T) of the same code element.

Returns

double

Remarks

The returned value can be positive, zero or negative.

Exceptions

ArgumentException

codeElement is not present in NewerIssuesSet nor OlderIssuesSet.

AnnualInterestPercentDiff(IIssue)

Gets ExtensionMethodsDebtUsableInCQLinq.AnnualInterestPercent(Debt, AnnualInterest)(DebtDiff(IIssue),AnnualInterestDiff(IIssue)).

double AnnualInterestPercentDiff(IIssue issue)

Parameters

issue IIssue

The issue object can be the NewerVersion(IIssue) or OlderVersion(IIssue) of the same issue.

Returns

double

Remarks

The returned value can be positive, zero or negative.

Exceptions

ArgumentException

issue is not present in NewerIssuesSet nor OlderIssuesSet.

AnnualInterestPercentDiff(IRule)

Gets ExtensionMethodsDebtUsableInCQLinq.AnnualInterestPercent(Debt, AnnualInterest)(DebtDiff(IRule),AnnualInterestDiff(IRule)).

double AnnualInterestPercentDiff(IRule rule)

Parameters

rule IRule

The rule object can be the NewerVersion(IRule) or OlderVersion(IRule) of the same rule.

Returns

double

Remarks

The returned value can be positive, zero or negative.

Exceptions

ArgumentException

rule is not present in NewerIssuesSet nor OlderIssuesSet.

BreakingPointDiff(ICodeElement)

Gets ExtensionMethodsDebtUsableInCQLinq.BreakingPoint(Debt, AnnualInterest)(DebtDiff(ICodeElement),AnnualInterestDiff(ICodeElement)).

TimeSpan BreakingPointDiff(ICodeElement codeElement)

Parameters

codeElement ICodeElement

The code element object can be the NewerVersion<T>(T) or OlderVersion<T>(T) of the same code element.

Returns

TimeSpan

Remarks

The returned TimeSpan value can be positive, zero or negative.

Exceptions

ArgumentException

codeElement is not present in NewerIssuesSet nor OlderIssuesSet.

BreakingPointDiff(IIssue)

Gets ExtensionMethodsDebtUsableInCQLinq.BreakingPoint(Debt, AnnualInterest)(DebtDiff(IIssue),AnnualInterestDiff(IIssue)).

TimeSpan BreakingPointDiff(IIssue issue)

Parameters

issue IIssue

The issue object can be the NewerVersion(IIssue) or OlderVersion(IIssue) of the same issue.

Returns

TimeSpan

Remarks

The returned TimeSpan value can be positive, zero or negative.

Exceptions

ArgumentException

issue is not present in NewerIssuesSet nor OlderIssuesSet.

BreakingPointDiff(IRule)

Gets ExtensionMethodsDebtUsableInCQLinq.BreakingPoint(Debt, AnnualInterest)(DebtDiff(IRule),AnnualInterestDiff(IRule)).

TimeSpan BreakingPointDiff(IRule rule)

Parameters

rule IRule

The rule object can be the NewerVersion(IRule) or OlderVersion(IRule) of the same rule.

Returns

TimeSpan

Remarks

The returned TimeSpan value can be positive, zero or negative.

Exceptions

ArgumentException

rule is not present in NewerIssuesSet nor OlderIssuesSet.

DebtDiff(ICodeElement)

Gets NewerIssuesSet.Debt(ICodeElement) of NewerVersion<T>(T) of codeElement, minus OlderIssuesSet.Debt(ICodeElement) of OlderVersion<T>(T) of codeElement.

Debt DebtDiff(ICodeElement codeElement)

Parameters

codeElement ICodeElement

The code element object can be the NewerVersion<T>(T) or OlderVersion<T>(T) of the same code element.

Returns

Debt

Remarks

If NewerVersion<T>(T) or OlderVersion<T>(T) of codeElement is null, Debt.Zero value is taken instead.
The returned Debt value can be positive, zero or negative.

Exceptions

ArgumentException

codeElement is not present in NewerIssuesSet nor OlderIssuesSet.

DebtDiff(IIssue)

Gets NewerVersion(IIssue).Debt of issue, minus OlderVersion(IIssue).Debt of issue,

Debt DebtDiff(IIssue issue)

Parameters

issue IIssue

The issue object can be the NewerVersion(IIssue) or OlderVersion(IIssue) of the same issue.

Returns

Debt

Remarks

If NewerVersion(IIssue) or OlderVersion(IIssue) of issue is null, Debt.Zero value is taken instead.
The returned Debt value can be positive, zero or negative.

Exceptions

ArgumentException

issue is not present in NewerIssuesSet nor OlderIssuesSet.

DebtDiff(IRule)

Gets NewerIssuesSet.Debt(IRule) of NewerVersion(IRule) of rule, minus OlderIssuesSet.Debt(IRule) of OlderVersion(IRule) of rule.

Debt DebtDiff(IRule rule)

Parameters

rule IRule

The rule object can be the NewerVersion(IRule) or OlderVersion(IRule) of the same rule.

Returns

Debt

Remarks

If NewerVersion(IRule) or OlderVersion(IRule) of rule is null, Debt.Zero value is taken instead.
The returned Debt value can be positive, zero or negative.

Exceptions

ArgumentException

rule is not present in NewerIssuesSet nor OlderIssuesSet.

DebtRatingChanged(ICodeElement)

Gets a value that indicates if codeElement.DebtRating(ICodeElement) is different for NewerVersion<T>(T) and OlderVersion<T>(T) of codeElement.

bool DebtRatingChanged(ICodeElement codeElement)

Parameters

codeElement ICodeElement

The code element object can be the NewerVersion<T>(T) or OlderVersion<T>(T) of the same code element.

Returns

bool

Remarks

This methods returns false if NewerVersion<T>(T) or OlderVersion<T>(T) of codeElement is null.
If codeElement.DebtRating(ICodeElement) is null for NewerVersion<T>(T) or OlderVersion<T>(T), DebtRating.A is taken instead.

Exceptions

ArgumentException

codeElement is not present in NewerIssuesSet nor OlderIssuesSet.

DebtRatingImproved(ICodeElement)

Gets a value that indicates if codeElement.DebtRating(ICodeElement) is better for NewerVersion<T>(T) than for OlderVersion<T>(T) of codeElement.

bool DebtRatingImproved(ICodeElement codeElement)

Parameters

codeElement ICodeElement

The code element object can be the NewerVersion<T>(T) or OlderVersion<T>(T) of the same code element.

Returns

bool

Remarks

This methods returns false if NewerVersion<T>(T) or OlderVersion<T>(T) of codeElement is null.
If codeElement.DebtRating(ICodeElement) is null for NewerVersion<T>(T) or OlderVersion<T>(T), DebtRating.A is taken instead.

Exceptions

ArgumentException

codeElement is not present in NewerIssuesSet nor OlderIssuesSet.

DebtRatingWorsened(ICodeElement)

Gets a value that indicates if codeElement.DebtRating(ICodeElement) is better for OlderVersion<T>(T) than for NewerVersion<T>(T) of codeElement.

bool DebtRatingWorsened(ICodeElement codeElement)

Parameters

codeElement ICodeElement

The code element object can be the NewerVersion<T>(T) or OlderVersion<T>(T) of the same code element.

Returns

bool

Remarks

This methods returns false if NewerVersion<T>(T) or OlderVersion<T>(T) of codeElement is null.
If codeElement.DebtRating(ICodeElement) is null for NewerVersion<T>(T) or OlderVersion<T>(T), DebtRating.A is taken instead.

Exceptions

ArgumentException

codeElement is not present in NewerIssuesSet nor OlderIssuesSet.

DebtRatioDiff(ICodeElement)

Gets NewerIssuesSet.DebtRatio(ICodeElement) of NewerVersion<T>(T) of codeElement, minus OlderIssuesSet.DebtRatio(ICodeElement) of OlderVersion<T>(T) of codeElement.

double? DebtRatioDiff(ICodeElement codeElement)

Parameters

codeElement ICodeElement

The code element object can be the NewerVersion<T>(T) or OlderVersion<T>(T) of the same code element.

Returns

double?

Remarks

If NewerVersion<T>(T) or OlderVersion<T>(T) of codeElement is null, this method returns null.

If NewerIssuesSet.DebtRatio(ICodeElement) of NewerVersion<T>(T) of codeElement, or OlderIssuesSet.DebtRatio(ICodeElement) of OlderVersion<T>(T) of codeElement is null, this method returns null.

The returned value can be null or else, positive, zero or negative.

Exceptions

ArgumentException

codeElement is not present in NewerIssuesSet nor OlderIssuesSet.

IsInNewerIssuesSet(IIssue)

Gets a value that indicates if issue is in NewerIssuesSet.

bool IsInNewerIssuesSet(IIssue issue)

Parameters

issue IIssue

The issue.

Returns

bool

Exceptions

ArgumentException

issue is not present in NewerIssuesSet nor OlderIssuesSet.

IsInNewerIssuesSet(IQualityGate)

Gets a value that indicates if qualityGate is in NewerIssuesSet.

bool IsInNewerIssuesSet(IQualityGate qualityGate)

Parameters

qualityGate IQualityGate

The quality gate.

Returns

bool

Exceptions

ArgumentException

qualityGate is not present in NewerIssuesSet nor OlderIssuesSet.

IsInNewerIssuesSet(IRule)

Gets a value that indicates if rule is in NewerIssuesSet.

bool IsInNewerIssuesSet(IRule rule)

Parameters

rule IRule

The rule.

Returns

bool

Exceptions

ArgumentException

rule is not present in NewerIssuesSet nor OlderIssuesSet.

IsInNewerOrOlderIssuesSet(IIssue)

Gets a value that indicates if issue is in NewerIssuesSet or in OlderIssuesSet.

bool IsInNewerOrOlderIssuesSet(IIssue issue)

Parameters

issue IIssue

The issue.

Returns

bool

IsInOlderIssuesSet(IIssue)

Gets a value that indicates if issue is in OlderIssuesSet.

bool IsInOlderIssuesSet(IIssue issue)

Parameters

issue IIssue

The issue.

Returns

bool

Exceptions

ArgumentException

issue is not present in NewerIssuesSet nor OlderIssuesSet.

IsInOlderIssuesSet(IQualityGate)

Gets a value that indicates if qualityGate is in OlderIssuesSet.

bool IsInOlderIssuesSet(IQualityGate qualityGate)

Parameters

qualityGate IQualityGate

The quality gate.

Returns

bool

Exceptions

ArgumentException

qualityGate is not present in NewerIssuesSet nor OlderIssuesSet.

IsInOlderIssuesSet(IRule)

Gets a value that indicates if rule is in OlderIssuesSet.

bool IsInOlderIssuesSet(IRule rule)

Parameters

rule IRule

The rule.

Returns

bool

Exceptions

ArgumentException

rule is not present in NewerIssuesSet nor OlderIssuesSet.

IsNotViolatedAnymore(IRule)

Gets a value that indicates if rule is present in both NewerIssuesSet and OlderIssuesSet and is violated in OlderIssuesSet and not in NewerIssuesSet.

bool IsNotViolatedAnymore(IRule rule)

Parameters

rule IRule

The rule object can be the NewerVersion(IRule) or OlderVersion(IRule) of the same rule.

Returns

bool

Exceptions

ArgumentException

rule is not present in NewerIssuesSet nor OlderIssuesSet.

IsPresentInBothIssuesSet(IIssue)

Gets a value that indicates if issue is in NewerIssuesSet or OlderIssuesSet and has an equivalent in the other issues-set.

bool IsPresentInBothIssuesSet(IIssue issue)

Parameters

issue IIssue

The issue object can be the NewerVersion(IIssue) or OlderVersion(IIssue) of the same issue.

Returns

bool

Remarks

if issue.IsSuppressed is true, this method returns false.

Exceptions

ArgumentException

issue is not present in NewerIssuesSet nor OlderIssuesSet.

IsPresentInBothIssuesSet(IQualityGate)

Gets a value that indicates if qualityGate is in NewerIssuesSet or OlderIssuesSet and has an equivalent in the other issues-set.

bool IsPresentInBothIssuesSet(IQualityGate qualityGate)

Parameters

qualityGate IQualityGate

The quality gate object can be the NewerVersion(IQualityGate) or OlderVersion(IQualityGate) of the same qualityGate.

Returns

bool

Exceptions

ArgumentException

qualityGate is not present in NewerIssuesSet nor OlderIssuesSet.

IsPresentInBothIssuesSet(IRule)

Gets a value that indicates if rule is in NewerIssuesSet or OlderIssuesSet and has an equivalent in the other issues-set.

bool IsPresentInBothIssuesSet(IRule rule)

Parameters

rule IRule

The rule object can be the NewerVersion(IRule) or OlderVersion(IRule) of the same rule.

Returns

bool

Exceptions

ArgumentException

rule is not present in NewerIssuesSet nor OlderIssuesSet.

IssuesAdded(ICodeElement)

Gets all issues on codeElement that have no equivalent in OlderIssuesSet. These issues are considered as added.

IEnumerable<IIssue> IssuesAdded(ICodeElement codeElement)

Parameters

codeElement ICodeElement

The code element object can be the NewerVersion<T>(T) or OlderVersion<T>(T) of the same code element.

Returns

IEnumerable<IIssue>

Remarks

The issues of NewerIssuesSet and OlderIssuesSet are paired when they share the same Rule and the same CodeElement.
If OlderVersion<T>(T) of codeElement is null, all issues on codeElement are returned.

Exceptions

ArgumentException

codeElement is not present in NewerIssuesSet nor OlderIssuesSet.

IssuesAdded(IRule)

Gets all issues of rule that have no equivalent in OlderIssuesSet. These issues are considered as added.

IEnumerable<IIssue> IssuesAdded(IRule rule)

Parameters

rule IRule

The rule object can be the NewerVersion(IRule) or OlderVersion(IRule) of the same rule.

Returns

IEnumerable<IIssue>

Remarks

The issues of NewerIssuesSet and OlderIssuesSet are paired when they share the same Rule and the same CodeElement.
If OlderVersion(IRule) of rule is null, all issues of rule are returned.

Exceptions

ArgumentException

rule is not present in NewerIssuesSet nor OlderIssuesSet.

IssuesFixed(ICodeElement)

Gets all issues on codeElement that have no equivalent in NewerIssuesSet. These issues are considered as fixed.

IEnumerable<IIssue> IssuesFixed(ICodeElement codeElement)

Parameters

codeElement ICodeElement

The code element object can be the NewerVersion<T>(T) or OlderVersion<T>(T) of the same code element.

Returns

IEnumerable<IIssue>

Remarks

The issues of NewerIssuesSet and OlderIssuesSet are paired when they share the same Rule and the same CodeElement.
If NewerVersion<T>(T) of codeElement is null, all issues on codeElement are returned.

Exceptions

ArgumentException

codeElement is not present in NewerIssuesSet nor OlderIssuesSet.

IssuesFixed(IRule)

Gets all issues of rule that have no equivalent in NewerIssuesSet. These issues are considered as fixed.

IEnumerable<IIssue> IssuesFixed(IRule rule)

Parameters

rule IRule

The rule object can be the NewerVersion(IRule) or OlderVersion(IRule) of the same rule.

Returns

IEnumerable<IIssue>

Remarks

The issues of NewerIssuesSet and OlderIssuesSet are paired when they share the same Rule and the same CodeElement.
If NewerVersion(IRule) of rule is null, all issues of rule are returned.

Exceptions

ArgumentException

rule is not present in NewerIssuesSet nor OlderIssuesSet.

NewerVersion(IIssue)

Gets the issue in NewerIssuesSet, or null if issue has no equivalent in NewerIssuesSet.

IIssue NewerVersion(IIssue issue)

Parameters

issue IIssue

The issue.

Returns

IIssue

Remarks

If issue is already in NewerIssuesSet, this method returns it.

Exceptions

ArgumentException

issue is not present in NewerIssuesSet nor OlderIssuesSet.

NewerVersion(IQualityGate)

Gets the qualityGate in NewerIssuesSet, or null if qualityGate has no equivalent in NewerIssuesSet.

IQualityGate NewerVersion(IQualityGate qualityGate)

Parameters

qualityGate IQualityGate

The quality gate.

Returns

IQualityGate

Remarks

If qualityGate is already in NewerIssuesSet, this method returns it.

Exceptions

ArgumentException

qualityGate is not present in NewerIssuesSet nor OlderIssuesSet.

NewerVersion(IRule)

Gets the rule in NewerIssuesSet, or null if rule has no equivalent in NewerIssuesSet.

IRule NewerVersion(IRule rule)

Parameters

rule IRule

The rule.

Returns

IRule

Remarks

If rule is already in NewerIssuesSet, this method returns it.

Exceptions

ArgumentException

rule is not present in NewerIssuesSet nor OlderIssuesSet.

OlderVersion(IIssue)

Gets the issue in OlderIssuesSet, or null if issue has no equivalent in OlderIssuesSet.

IIssue OlderVersion(IIssue issue)

Parameters

issue IIssue

The issue.

Returns

IIssue

Remarks

If issue is already in OlderIssuesSet, this method returns it.

Exceptions

ArgumentException

issue is not present in NewerIssuesSet nor OlderIssuesSet.

OlderVersion(IQualityGate)

Gets the qualityGate in OlderIssuesSet, or null if qualityGate has no equivalent in OlderIssuesSet.

IQualityGate OlderVersion(IQualityGate qualityGate)

Parameters

qualityGate IQualityGate

The quality gate.

Returns

IQualityGate

Remarks

If qualityGate is already in OlderIssuesSet, this method returns it.

Exceptions

ArgumentException

qualityGate is not present in NewerIssuesSet nor OlderIssuesSet.

OlderVersion(IRule)

Gets the rule in OlderIssuesSet, or null if rule has no equivalent in OlderIssuesSet.

IRule OlderVersion(IRule rule)

Parameters

rule IRule

The rule.

Returns

IRule

Remarks

If rule is already in OlderIssuesSet, this method returns it.

Exceptions

ArgumentException

rule is not present in NewerIssuesSet nor OlderIssuesSet.

SeverityChanged(IIssue)

Gets a value that indicates if issue.Severity is different for NewerVersion(IIssue) and OlderVersion(IIssue) of issue.

bool SeverityChanged(IIssue issue)

Parameters

issue IIssue

The issue object can be the NewerVersion(IIssue) or OlderVersion(IIssue) of the same issue.

Returns

bool

Remarks

This methods returns false if NewerVersion(IIssue) or OlderVersion(IIssue) of issue is null.

Exceptions

ArgumentException

issue is not present in NewerIssuesSet nor OlderIssuesSet.

SeverityDecreased(IIssue)

Gets a value that indicates if issue.Severity has decreased between NewerVersion(IIssue) and OlderVersion(IIssue) of issue.

bool SeverityDecreased(IIssue issue)

Parameters

issue IIssue

The issue object can be the NewerVersion(IIssue) or OlderVersion(IIssue) of the same issue.

Returns

bool

Remarks

This methods returns false if NewerVersion(IIssue) or OlderVersion(IIssue) of issue is null.
Severity decrease means for example that Severity.Low is considered less severe than Severity.Blocker.

Exceptions

ArgumentException

issue is not present in NewerIssuesSet nor OlderIssuesSet.

SeverityIncreased(IIssue)

Gets a value that indicates if issue.Severity has increased between NewerVersion(IIssue) and OlderVersion(IIssue) of issue.

bool SeverityIncreased(IIssue issue)

Parameters

issue IIssue

The issue object can be the NewerVersion(IIssue) or OlderVersion(IIssue) of the same issue.

Returns

bool

Remarks

This methods returns false if NewerVersion(IIssue) or OlderVersion(IIssue) of issue is null.
Severity increase means for example that Severity.Blocker is considered more severe than Severity.Low.

Exceptions

ArgumentException

issue is not present in NewerIssuesSet nor OlderIssuesSet.

ValueDiff(IQualityGate)

Gets the Value of NewerVersion(IQualityGate) of qualityGate, minus the Value of OlderVersion(IQualityGate) of qualityGate.

double? ValueDiff(IQualityGate qualityGate)

Parameters

qualityGate IQualityGate

The quality gate object can be the NewerVersion(IQualityGate) or OlderVersion(IQualityGate) of the same quality gate.

Returns

double?

Remarks

If the older or newer value is null returns null.

Exceptions

ArgumentException

qualityGate is not present in NewerIssuesSet nor OlderIssuesSet.

WasAdded(IIssue)

Gets a value that indicates if issue is present in NewerIssuesSet and has no equivalent in OlderIssuesSet. It is then considered as an issue added.

bool WasAdded(IIssue issue)

Parameters

issue IIssue

The issue object can be the NewerVersion(IIssue) or OlderVersion(IIssue) of the same issue.

Returns

bool

Remarks

If issue is the OlderVersion(IIssue) of the issue, this method returns false.
If issue.IsSuppressed is true, this method returns false.

Exceptions

ArgumentException

issue is not present in NewerIssuesSet nor OlderIssuesSet.

WasFixed(IIssue)

Gets a value that indicates if issue is present in OlderIssuesSet and has no equivalent in NewerIssuesSet. It is then considered as a fixed issue.

bool WasFixed(IIssue issue)

Parameters

issue IIssue

The issue object can be the NewerVersion(IIssue) or OlderVersion(IIssue) of the same issue.

Returns

bool

Remarks

If issue is the NewerVersion(IIssue) of the issue, this method returns false.
If issue.IsSuppressed is true, this method returns false.

Exceptions

ArgumentException

issue is not present in NewerIssuesSet nor OlderIssuesSet.

WasNotViolatedAndIsViolated(IRule)

Gets a value that indicates if rule is present in both NewerIssuesSet and OlderIssuesSet and is violated in NewerIssuesSet and not in OlderIssuesSet.

bool WasNotViolatedAndIsViolated(IRule rule)

Parameters

rule IRule

The rule object can be the NewerVersion(IRule) or OlderVersion(IRule) of the same rule.

Returns

bool

Exceptions

ArgumentException

rule is not present in NewerIssuesSet nor OlderIssuesSet.