org.sonar.plugins.toxicity.model

Class Toxicity

java.lang.Object

org.sonar.plugins.toxicity.model.Toxicity

All Implemented Interfaces:

ToxicityNode

public class Toxicity
extends Object
implements ToxicityNode

Author:

ccoca

Field Summary

Fields

Modifier and Type	Field and Description
static String	NODE_NAME

Constructor Summary

Constructors

Constructor and Description
Toxicity()

Method Summary

Methods

Modifier and Type	Method and Description
Node	convertToXml(Document xml)
Double	getAverageCost() Compute the average cost.
List<Source>	getSources() Returns the list of sources with debts.
List<Source>	getSources(BigDecimal threshold) The list of sources for which the total debt is greater than the provided threshold.
BigDecimal	getTotalCostByDebt(DebtType debtType)
void	readFromXml(Node node)
void	setSources(Collection<Source> sources)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NODE_NAME

public static final String NODE_NAME

See Also:

Constant Field Values

Constructor Detail

Toxicity

public Toxicity()

Method Detail

convertToXml

public Node convertToXml(Document xml)

Specified by:

convertToXml in interface ToxicityNode

readFromXml

public void readFromXml(Node node)

Specified by:

readFromXml in interface ToxicityNode

setSources

public void setSources(Collection<Source> sources)

getSources

public List<Source> getSources()

Returns the list of sources with debts. The list is sorted by total cost of debts.

Returns:

getSources

public List<Source> getSources(BigDecimal threshold)

The list of sources for which the total debt is greater than the provided threshold. The list is sorted by total cost of debts.

Returns:

getAverageCost

public Double getAverageCost()

Compute the average cost.

Returns:

Double - the average computed value or zero if no debts are found.

getTotalCostByDebt

public BigDecimal getTotalCostByDebt(DebtType debtType)

toString

public String toString()

Overrides:

toString in class Object