org.sonar.squid.api
Class SourceCode

java.lang.Object
  org.sonar.squid.api.SourceCode

All Implemented Interfaces:

Comparable<SourceCode>, Measurable

Direct Known Subclasses:

SourceClass, SourceFile, SourceMethod, SourcePackage, SourceProject

public abstract class SourceCode
extends Object
implements 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)
SourceCode	addChild(SourceCode sourceCode)
void	addData(Metric metric, Object data)
int	compareTo(SourceCode resource)
void	computeMeasures()
boolean	equals(Object obj)
Set<SourceCode>	getChildren()
Object	getData(Metric metric)
double	getDouble(Metric metric)
int	getEndAtLine()
SourceCode	getFirstChild()
int	getInt(Metric metric)
String	getKey()
SourceCode	getLastChild()
String	getName()
SourceCode	getParent()
SourceCode	getParent(Class<? extends SourceCode> sourceCode)
int	getStartAtLine()
boolean	hasAmongParents(SourceCode expectedParent)
boolean	hasChild(SourceCode squidUnit)
int	hashCode()
boolean	isType(Class<? extends SourceCode> resourceType)
void	removeMeasure(Metric metric)
void	setEndAtLine(int endAtLine)
void	setMeasure(Metric metric, double measure)
void	setMeasure(Metric metric, int measure)
void	setSourceCodeIndexer(SourceCodeIndexer indexer)
void	setStartAtLine(int startAtLine)
String	toString()

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()

compareTo

public int compareTo(SourceCode resource)

Specified by:

compareTo in interface Comparable<SourceCode>

getName

public String getName()

setSourceCodeIndexer

public final void setSourceCodeIndexer(SourceCodeIndexer indexer)

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()

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)

addData

public void addData(Metric metric,
                    Object data)

getData

public Object getData(Metric metric)

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

removeMeasure

public void removeMeasure(Metric metric)

setStartAtLine

public void setStartAtLine(int startAtLine)

setEndAtLine

public void setEndAtLine(int endAtLine)

getStartAtLine

public int getStartAtLine()

getEndAtLine

public int getEndAtLine()

addChild

public SourceCode addChild(SourceCode sourceCode)

getParent

public SourceCode getParent(Class<? extends SourceCode> sourceCode)

getFirstChild

public SourceCode getFirstChild()

getLastChild

public SourceCode getLastChild()

getParent

public SourceCode getParent()

getChildren

public Set<SourceCode> getChildren()

hasChild

public boolean hasChild(SourceCode squidUnit)

hasAmongParents

public boolean hasAmongParents(SourceCode expectedParent)