org.sonar.squid.api
Class SourceCode

java.lang.Object
  java.util.Observable
      org.sonar.squid.api.TreeNode<SourceCode>
          org.sonar.squid.api.SourceCode

All Implemented Interfaces:

Comparable<SourceCode>, Node, Measurable

Direct Known Subclasses:

SourceClass, SourceFile, SourceMethod, SourcePackage, SourceProject

public abstract class SourceCode
extends TreeNode<SourceCode>
implements Node, Measurable, Comparable<SourceCode>

Constructor Summary

SourceCode(String key)

SourceCode(String key, String name)

Method Summary

void	add(Metric metric, double value)
void	add(Metric metric, SourceCode child)
int	compareTo(SourceCode resource)
void	computeMeasures()
void	createEdgeWith(Node to, EdgeUsage link)
void	createEdgeWith(Node to, EdgeUsage link, Edge rootEdge)
Set<Node>	dependedUpon()
Set<Node>	dependsUpon()
boolean	equals(Object obj)
double	getDouble(Metric metric)
Edge	getEdgeFrom(Node from)
Edge	getEdgeTo(Node to)
int	getEndAtLine()
int	getInt(Metric metric)
String	getKey()
String	getName()
int	getStartAtLine()
EdgeUsage	getUsageBy(Node from)
EdgeUsage	getUsageOf(Node to)
int	hashCode()
protected abstract void	initializeMeasures()
boolean	isType(Class<? extends SourceCode> resourceType)
void	setEndAtLine(int endAtLine)
void	setMeasure(Metric metric, double measure)
void	setMeasure(Metric metric, int measure)
void	setStartAtLine(int startAtLine)
String	toString()
protected abstract void	updateMeasuresAfterConsolidation()

Methods inherited from class org.sonar.squid.api.TreeNode

addChild, getChildren, getFirstChild, getLastChild, getParent, getParent, hasAmongParents, hasChild

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceCode

public SourceCode(String key)

SourceCode

public SourceCode(String key,
                  String name)

Method Detail

getKey

public String getKey()

Specified by:

getKey in interface Node

compareTo

public int compareTo(SourceCode resource)

Specified by:

compareTo in interface Comparable<SourceCode>

getName

public String getName()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

computeMeasures

public final void computeMeasures()

createEdgeWith

public void createEdgeWith(Node to,
                           EdgeUsage link)

Specified by:

createEdgeWith in interface Node

createEdgeWith

public void createEdgeWith(Node to,
                           EdgeUsage link,
                           Edge rootEdge)

Specified by:

createEdgeWith in interface Node

getEdgeTo

public Edge getEdgeTo(Node to)

Specified by:

getEdgeTo in interface Node

getEdgeFrom

public Edge getEdgeFrom(Node from)

Specified by:

getEdgeFrom in interface Node

getUsageOf

public EdgeUsage getUsageOf(Node to)

Specified by:

getUsageOf in interface Node

getUsageBy

public EdgeUsage getUsageBy(Node from)

Specified by:

getUsageBy in interface Node

dependedUpon

public Set<Node> dependedUpon()

Specified by:

dependedUpon in interface Node

dependsUpon

public Set<Node> dependsUpon()

Specified by:

dependsUpon in interface Node

isType

public boolean isType(Class<? extends SourceCode> resourceType)

getInt

public int getInt(Metric metric)

Specified by:

getInt in interface Measurable

getDouble

public double getDouble(Metric metric)

Specified by:

getDouble in interface Measurable

add

public void add(Metric metric,
                SourceCode child)

add

public void add(Metric metric,
                double value)

setMeasure

public void setMeasure(Metric metric,
                       double measure)

Specified by:

setMeasure in interface Measurable

setMeasure

public void setMeasure(Metric metric,
                       int measure)

Specified by:

setMeasure in interface Measurable

initializeMeasures

protected abstract void initializeMeasures()

updateMeasuresAfterConsolidation

protected abstract void updateMeasuresAfterConsolidation()

setStartAtLine

public void setStartAtLine(int startAtLine)

setEndAtLine

public void setEndAtLine(int endAtLine)

getStartAtLine

public int getStartAtLine()

getEndAtLine

public int getEndAtLine()