Package com.reallifedeveloper.maven.jdepend.xml

Class XmlReport

java.lang.Object

com.reallifedeveloper.maven.jdepend.xml.XmlReport

public class XmlReport
extends Object

A representation of the XML report generated by JDepend.

Author:

RealLifeDeveloper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XmlReport.XmlClass	Contains information from the Class element.
static class	XmlReport.XmlPackage	Contains information from the Package element.
static class	XmlReport.XmlPackageWithCycle	Contains information from the Cycles element.
static class	XmlReport.XmlStats	Contains information from the Stats element.

Constructor Summary

Constructors

Constructor	Description
XmlReport()

Method Summary

Modifier and Type	Method	Description
Optional<XmlReport.XmlPackageWithCycle>	findPackageWithCycle(String packageName)	If the given package has any cycles, provides information about this.
List<XmlReport.XmlPackage>	packagesWithError()	Gives the packages that were included in the JDepend report, but not successfully analyzed.
List<XmlReport.XmlPackage>	packagesWithoutError()	Gives the packages that were successfully analyzed by JDepend.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

XmlReport

public XmlReport()

Method Details

packagesWithoutError

public List<XmlReport.XmlPackage> packagesWithoutError()

Gives the packages that were successfully analyzed by JDepend.

The XML report generataed by JDepend includes external packages, e.g., java.lang, but with an error message saying something like package referenced, but not analyzed.

Returns:

the packages that were successfully analyzed by JDepend

packagesWithError

public List<XmlReport.XmlPackage> packagesWithError()

Gives the packages that were included in the JDepend report, but not successfully analyzed.

Returns:

the packages that were included in the JDepend report, but not successfully analyzed

findPackageWithCycle

public Optional<XmlReport.XmlPackageWithCycle> findPackageWithCycle(String packageName)

If the given package has any cycles, provides information about this.

Parameters:

packageName - the name of the package to check

Returns:

an optional containing an XmlReport.XmlPackageWithCycle if the package named packageName contains cycles, an empty optional otherwise