jdepend.textui

Class JDepend

Known Direct Subclasses:
JDepend

public class JDepend
extends java.lang.Object

The JDepend class analyzes directories of Java class files, generates metrics for each Java package, and reports the metrics in a textual format.
Authors:
Mike Clark (mike@clarkware.com)
Clarkware Consulting, Inc.

Field Summary

protected NumberFormat
formatter

Constructor Summary

JDepend()
Constructs a JDepend instance using standard output.
JDepend(PrintWriter writer)
Constructs a JDepend instance with the specified writer.

Method Summary

void
addDirectory(String name)
Adds the specified directory name to the collection of directories to be analyzed.
void
analyze()
Analyzes the registered directories, generates metrics for each Java package, and reports the metrics.
void
analyzeInnerClasses(boolean b)
Determines whether inner classes are analyzed.
protected PrintWriter
getWriter()
protected void
instanceMain(String[] args)
static void
main(args[] )
Main.
protected void
printAbstractClasses(JavaPackage jPackage)
protected void
printAbstractClassesFooter()
protected void
printAbstractClassesHeader()
protected void
printAfferents(JavaPackage jPackage)
protected void
printAfferentsError()
protected void
printAfferentsFooter()
protected void
printAfferentsHeader()
protected void
printClassName(JavaClass jClass)
protected void
printConcreteClasses(JavaPackage jPackage)
protected void
printConcreteClassesFooter()
protected void
printConcreteClassesHeader()
protected void
printCycle(JavaPackage jPackage)
protected void
printCycleContributor(JavaPackage jPackage)
protected void
printCycleFooter()
protected void
printCycleHeader(JavaPackage jPackage)
protected void
printCycleTarget(JavaPackage jPackage)
protected void
printCycles(Collection packages)
protected void
printCyclesFooter()
protected void
printCyclesHeader()
protected void
printEfferents(JavaPackage jPackage)
protected void
printEfferentsError()
protected void
printEfferentsFooter()
protected void
printEfferentsHeader()
protected void
printFooter()
protected void
printHeader()
protected void
printNoStats()
protected void
printPackage(JavaPackage jPackage)
protected void
printPackageFooter(JavaPackage jPackage)
protected void
printPackageHeader(JavaPackage jPackage)
protected void
printPackageName(JavaPackage jPackage)
protected void
printPackages(Collection packages)
protected void
printPackagesFooter()
protected void
printPackagesHeader()
protected void
printSectionBreak()
protected void
printStatistics(JavaPackage jPackage)
protected void
printSummary(Collection packages)
void
setFilter(PackageFilter filter)
Sets the package filter.
void
setWriter(PrintWriter writer)
Sets the output writer.
protected String
tab()
protected String
tab(int n)
protected String
toFormattedString(float f)
protected void
usage(String message)

Field Details

formatter

protected NumberFormat formatter

Constructor Details

JDepend

public JDepend()
Constructs a JDepend instance using standard output.

JDepend

public JDepend(PrintWriter writer)
Constructs a JDepend instance with the specified writer.
Parameters:
writer - Writer.

Method Details

addDirectory

public void addDirectory(String name)
            throws IOException
Adds the specified directory name to the collection of directories to be analyzed.
Parameters:
name - Directory name.

analyze

public void analyze()
Analyzes the registered directories, generates metrics for each Java package, and reports the metrics.

analyzeInnerClasses

public void analyzeInnerClasses(boolean b)
Determines whether inner classes are analyzed.
Parameters:
b - true to analyze inner classes; false otherwise.

getWriter

protected PrintWriter getWriter()

instanceMain

protected void instanceMain(String[] args)

main

public static void main(args[] )
Main.

printAbstractClasses

protected void printAbstractClasses(JavaPackage jPackage)

printAbstractClassesFooter

protected void printAbstractClassesFooter()

printAbstractClassesHeader

protected void printAbstractClassesHeader()

printAfferents

protected void printAfferents(JavaPackage jPackage)

printAfferentsError

protected void printAfferentsError()

printAfferentsFooter

protected void printAfferentsFooter()

printAfferentsHeader

protected void printAfferentsHeader()

printClassName

protected void printClassName(JavaClass jClass)

printConcreteClasses

protected void printConcreteClasses(JavaPackage jPackage)

printConcreteClassesFooter

protected void printConcreteClassesFooter()

printConcreteClassesHeader

protected void printConcreteClassesHeader()

printCycle

protected void printCycle(JavaPackage jPackage)

printCycleContributor

protected void printCycleContributor(JavaPackage jPackage)

printCycleFooter

protected void printCycleFooter()

printCycleHeader

protected void printCycleHeader(JavaPackage jPackage)

printCycleTarget

protected void printCycleTarget(JavaPackage jPackage)

printCycles

protected void printCycles(Collection packages)

printCyclesFooter

protected void printCyclesFooter()

printCyclesHeader

protected void printCyclesHeader()

printEfferents

protected void printEfferents(JavaPackage jPackage)

printEfferentsError

protected void printEfferentsError()

printEfferentsFooter

protected void printEfferentsFooter()

printEfferentsHeader

protected void printEfferentsHeader()

printFooter

protected void printFooter()

printHeader

protected void printHeader()

printNoStats

protected void printNoStats()

printPackage

protected void printPackage(JavaPackage jPackage)

printPackageFooter

protected void printPackageFooter(JavaPackage jPackage)

printPackageHeader

protected void printPackageHeader(JavaPackage jPackage)

printPackageName

protected void printPackageName(JavaPackage jPackage)

printPackages

protected void printPackages(Collection packages)

printPackagesFooter

protected void printPackagesFooter()

printPackagesHeader

protected void printPackagesHeader()

printSectionBreak

protected void printSectionBreak()

printStatistics

protected void printStatistics(JavaPackage jPackage)

printSummary

protected void printSummary(Collection packages)

setFilter

public void setFilter(PackageFilter filter)
Sets the package filter.
Parameters:
filter - Package filter.

setWriter

public void setWriter(PrintWriter writer)
Sets the output writer.
Parameters:
writer - Output writer.

tab

protected String tab()

tab

protected String tab(int n)

toFormattedString

protected String toFormattedString(float f)

usage

protected void usage(String message)

Copyright B) 1999-2003 Clarkware Consulting, Inc.