⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
jdepend.textui

Class JDepend

java.lang.Object
|
+--jdepend.textui.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@clarkware.com)
Clarkware Consulting, Inc.

Field Summary

java.text.NumberFormat

formatter

Constructor Summary

JDepend()

Constructs a JDepend instance using standard output.

JDepend(java.io.PrintWriter writer)

Constructs a JDepend instance with the specified writer.

Method Summary

void

addDirectory(java.lang.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.

java.io.PrintWriter

getWriter()

void

instanceMain(java.lang.String[] args)

static void

main(java.lang.String[] args)

Main.

void

printAbstractClasses(JavaPackage jPackage)

void

printAbstractClassesFooter()

void

printAbstractClassesHeader()

void

printAfferents(JavaPackage jPackage)

void

printAfferentsError()

void

printAfferentsFooter()

void

printAfferentsHeader()

void

printClassName(JavaClass jClass)

void

printConcreteClasses(JavaPackage jPackage)

void

printConcreteClassesFooter()

void

printConcreteClassesHeader()

void

printCycle(JavaPackage jPackage)

void

printCycleContributor(JavaPackage jPackage)

void

printCycleFooter()

void

printCycleHeader(JavaPackage jPackage)

void

printCycles(java.util.Collection packages)

void

printCyclesFooter()

void

printCyclesHeader()

void

printCycleTarget(JavaPackage jPackage)

void

printEfferents(JavaPackage jPackage)

void

printEfferentsError()

void

printEfferentsFooter()

void

printEfferentsHeader()

void

printFooter()

void

printHeader()

void

printNoStats()

void

printPackage(JavaPackage jPackage)

void

printPackageFooter(JavaPackage jPackage)

void

printPackageHeader(JavaPackage jPackage)

void

printPackageName(JavaPackage jPackage)

void

printPackages(java.util.Collection packages)

void

printPackagesFooter()

void

printPackagesHeader()

void

printSectionBreak()

void

printStatistics(JavaPackage jPackage)

void

printSummary(java.util.Collection packages)

void

setFilter(PackageFilter filter)

Sets the package filter.

void

setWriter(java.io.PrintWriter writer)

Sets the output writer.

java.lang.String

tab()

java.lang.String

tab(int n)

java.lang.String

toFormattedString(float f)

void

usage(java.lang.String message)

Field Details

formatter

protected NumberFormat formatter

Constructor Details

JDepend

public JDepend()

Constructs a JDepend instance using standard output.


JDepend

public JDepend(java.io.PrintWriter writer)

Constructs a JDepend instance with the specified writer.

Parameters:
writer - Writer.

Method Details

addDirectory

public void addDirectory(java.lang.String name)

Adds the specified directory name to the collection of directories to be analyzed.

Parameters:
name - Directory name.
Throws:
java.io.IOException - If the directory does not exist.

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(java.lang.String[] args)

Parameters:
args

main

public static void main(java.lang.String[] args)

Main.

Parameters:
args

printAbstractClasses

protected void printAbstractClasses(JavaPackage jPackage)

Parameters:
jPackage

printAbstractClassesFooter

protected void printAbstractClassesFooter()


printAbstractClassesHeader

protected void printAbstractClassesHeader()


printAfferents

protected void printAfferents(JavaPackage jPackage)

Parameters:
jPackage

printAfferentsError

protected void printAfferentsError()


printAfferentsFooter

protected void printAfferentsFooter()


printAfferentsHeader

protected void printAfferentsHeader()


printClassName

protected void printClassName(JavaClass jClass)

Parameters:
jClass

printConcreteClasses

protected void printConcreteClasses(JavaPackage jPackage)

Parameters:
jPackage

printConcreteClassesFooter

protected void printConcreteClassesFooter()


printConcreteClassesHeader

protected void printConcreteClassesHeader()


printCycle

protected void printCycle(JavaPackage jPackage)

Parameters:
jPackage

printCycleContributor

protected void printCycleContributor(JavaPackage jPackage)

Parameters:
jPackage

printCycleFooter

protected void printCycleFooter()


printCycleHeader

protected void printCycleHeader(JavaPackage jPackage)

Parameters:
jPackage

printCycles

protected void printCycles(java.util.Collection packages)

Parameters:
packages

printCyclesFooter

protected void printCyclesFooter()


printCyclesHeader

protected void printCyclesHeader()


printCycleTarget

protected void printCycleTarget(JavaPackage jPackage)

Parameters:
jPackage

printEfferents

protected void printEfferents(JavaPackage jPackage)

Parameters:
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)

Parameters:
jPackage

printPackageFooter

protected void printPackageFooter(JavaPackage jPackage)

Parameters:
jPackage

printPackageHeader

protected void printPackageHeader(JavaPackage jPackage)

Parameters:
jPackage

printPackageName

protected void printPackageName(JavaPackage jPackage)

Parameters:
jPackage

printPackages

protected void printPackages(java.util.Collection packages)

Parameters:
packages

printPackagesFooter

protected void printPackagesFooter()


printPackagesHeader

protected void printPackagesHeader()


printSectionBreak

protected void printSectionBreak()


printStatistics

protected void printStatistics(JavaPackage jPackage)

Parameters:
jPackage

printSummary

protected void printSummary(java.util.Collection packages)

Parameters:
packages

setFilter

public void setFilter(PackageFilter filter)

Sets the package filter.

Parameters:
filter - Package filter.

setWriter

public void setWriter(java.io.PrintWriter writer)

Sets the output writer.

Parameters:
writer - Output writer.

tab

protected String tab()


tab

protected String tab(int n)

Parameters:
n

toFormattedString

protected String toFormattedString(float f)

Parameters:
f

usage

protected void usage(java.lang.String message)

Parameters:
message