org.xenei.junit.contract.tooling

Class InterfaceReport

java.lang.Object

org.xenei.junit.contract.tooling.InterfaceReport

public class InterfaceReport
extends java.lang.Object

Class to produce report data about the state of the contract tests.

Constructor Summary

Constructors

Constructor and Description
InterfaceReport(java.lang.String[] packages, org.xenei.classpathutils.ClassPathFilter filter, java.lang.ClassLoader classLoader) Constructor.

Method Summary

Modifier and Type	Method and Description
org.xenei.classpathutils.ClassPathFilter	getClassFilter() Get the filter
java.util.List<java.lang.Throwable>	getErrors() Get the set of errors encountered when discovering contract tests.
java.util.Collection<InterfaceInfo>	getInterfaceInfoCollection() Get a collection of InterfaceInfo objects for the entire test suite.
java.util.Collection<java.lang.Class<?>>	getPackageClasses() Get the collection of Class objects that were included in the packages.
java.util.Set<java.lang.Class<?>>	getUnImplementedTests() Search for classes that extend interfaces with contract tests but that don't have an implementation of the test producer.
java.util.Set<java.lang.Class<?>>	getUntestedInterfaces() get a set of interfaces that do not have contract tests defined.

Methods inherited from class java.lang.Object

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

Constructor Detail

InterfaceReport

public InterfaceReport(java.lang.String[] packages,
                       org.xenei.classpathutils.ClassPathFilter filter,
                       java.lang.ClassLoader classLoader)

Constructor. If the filter parameter is null it defaults to true() and all classes are processed.

Parameters:

packages - The list of packages to process.

filter - the filter of classes to process. may be null.

classLoader - the class loader to use.

Method Detail

getInterfaceInfoCollection

public java.util.Collection<InterfaceInfo> getInterfaceInfoCollection()

Get a collection of InterfaceInfo objects for the entire test suite.

Returns:

The colleciton of InterfaceInfo objects.

getPackageClasses

public java.util.Collection<java.lang.Class<?>> getPackageClasses()

Get the collection of Class objects that were included in the packages.

Returns:

The collection of Class objects that were included in the packages.

getErrors

public java.util.List<java.lang.Throwable> getErrors()

Get the set of errors encountered when discovering contract tests. This is a list of all errors for all tests.

Returns:

The list of Throwable objects that represent errors.

getUntestedInterfaces

public java.util.Set<java.lang.Class<?>> getUntestedInterfaces()

get a set of interfaces that do not have contract tests defined.

Returns:

The list of interfaces that don't have contract tests defined.

getUnImplementedTests

public java.util.Set<java.lang.Class<?>> getUnImplementedTests()

Search for classes that extend interfaces with contract tests but that don't have an implementation of the test producer.

Returns:

the set of Classes that do not have contract tests.

getClassFilter

public org.xenei.classpathutils.ClassPathFilter getClassFilter()

Get the filter

Returns:

The filter used to filter classes.