jdepend.framework
Class JavaPackage

java.lang.Object
  extended byjdepend.framework.JavaPackage

public class JavaPackage
extends java.lang.Object

The JavaPackage class represents a Java package.

Author:
Mike Clark, Clarkware Consulting, Inc.

Constructor Summary
JavaPackage(java.lang.String name)
           
JavaPackage(java.lang.String name, int volatility)
           
 
Method Summary
 float abstractness()
           
 void addAfferent(JavaPackage jPackage)
          Adds the specified Java package as an afferent of this package.
 void addClass(JavaClass clazz)
           
 void addEfferent(JavaPackage jPackage)
           
 int afferentCoupling()
           
 boolean collectAllCycles(java.util.List list)
          Collects all the packages participating in a package dependency cycle which originates from this package.
 boolean collectCycle(java.util.List list)
          Collects the packages participating in the first package dependency cycle detected which originates from this package.
 boolean containsCycle()
           
 void dependsUpon(JavaPackage imported)
          Adds the specified Java package as an efferent of this package and adds this package as an afferent of it.
 float distance()
           
 int efferentCoupling()
           
 boolean equals(java.lang.Object other)
           
 int getAbstractClassCount()
           
 java.util.Collection getAfferents()
           
 int getClassCount()
           
 java.util.Collection getClasses()
           
 int getConcreteClassCount()
           
 java.util.Collection getEfferents()
           
 java.lang.String getName()
           
 int getVolatility()
           
 float instability()
           
 void setAfferents(java.util.Collection afferents)
           
 void setEfferents(java.util.Collection efferents)
           
 void setVolatility(int v)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JavaPackage

public JavaPackage(java.lang.String name)

JavaPackage

public JavaPackage(java.lang.String name,
                   int volatility)
Method Detail

getName

public java.lang.String getName()

getVolatility

public int getVolatility()
Returns:
The package's volatility (0-1).

setVolatility

public void setVolatility(int v)
Parameters:
v - Volatility (0-1).

containsCycle

public boolean containsCycle()

collectCycle

public boolean collectCycle(java.util.List list)
Collects the packages participating in the first package dependency cycle detected which originates from this package.

Parameters:
list - Collecting object to be populated with the list of JavaPackage instances in a cycle.
Returns:
true if a cycle exist; false otherwise.

collectAllCycles

public boolean collectAllCycles(java.util.List list)
Collects all the packages participating in a package dependency cycle which originates from this package.

This is a more exhaustive search than that employed by collectCycle.

Parameters:
list - Collecting object to be populated with the list of JavaPackage instances in a cycle.
Returns:
true if a cycle exist; false otherwise.

addClass

public void addClass(JavaClass clazz)

getClasses

public java.util.Collection getClasses()

getClassCount

public int getClassCount()

getAbstractClassCount

public int getAbstractClassCount()

getConcreteClassCount

public int getConcreteClassCount()

dependsUpon

public void dependsUpon(JavaPackage imported)
Adds the specified Java package as an efferent of this package and adds this package as an afferent of it.

Parameters:
imported - Java package.

addAfferent

public void addAfferent(JavaPackage jPackage)
Adds the specified Java package as an afferent of this package.

Parameters:
jPackage - Java package.

getAfferents

public java.util.Collection getAfferents()

setAfferents

public void setAfferents(java.util.Collection afferents)

addEfferent

public void addEfferent(JavaPackage jPackage)

getEfferents

public java.util.Collection getEfferents()

setEfferents

public void setEfferents(java.util.Collection efferents)

afferentCoupling

public int afferentCoupling()
Returns:
The afferent coupling (Ca) of this package.

efferentCoupling

public int efferentCoupling()
Returns:
The efferent coupling (Ce) of this package.

instability

public float instability()
Returns:
Instability (0-1).

abstractness

public float abstractness()
Returns:
The package's abstractness (0-1).

distance

public float distance()
Returns:
The package's distance from the main sequence (D).

equals

public boolean equals(java.lang.Object other)


Copyright ? 1999-2004 Clarkware Consulting, Inc.