org.xenei.junit.contract.tooling

Class InterfaceReport

java.lang.Object

org.xenei.junit.contract.tooling.InterfaceReport

public class InterfaceReport
extends Object

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

Constructor Summary

Constructors

Constructor and Description
InterfaceReport(String[] packages, ClassFilter filter, ClassLoader classLoader) Constructor.

Method Summary

Modifier and Type	Method and Description
ClassFilter	getClassFilter() Get the filter
List<Throwable>	getErrors() Get the set of errors encountered when discovering contract tests.
Collection<InterfaceInfo>	getInterfaceInfoCollection()
Collection<Class<?>>	getPackageClasses()
Set<Class<?>>	getUnImplementedTests() Search for classes that extend interfaces with contract tests but that don't have an implementation of the test producer.
Set<Class<?>>	getUntestedInterfaces() get a set of interfaces that do not have contract tests defined.
static void	main(String[] args) Run the interface report generation.

Methods inherited from class java.lang.Object

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

Constructor Detail

InterfaceReport

public InterfaceReport(String[] packages,
                       ClassFilter filter,
                       ClassLoader classLoader)
                throws MalformedURLException

Constructor.

Parameters:

packages - The list of packages to process.

skipClasses - the list of classes to skip.

classLoader - the class loader to use.

Throws:

MalformedURLException

Method Detail

getInterfaceInfoCollection

public Collection<InterfaceInfo> getInterfaceInfoCollection()

getPackageClasses

public Collection<Class<?>> getPackageClasses()

getErrors

public List<Throwable> getErrors()

Get the set of errors encountered when discovering contract tests.

getUntestedInterfaces

public Set<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 Set<Class<?>> getUnImplementedTests()

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

Returns:

getClassFilter

public ClassFilter getClassFilter()

Get the filter

Returns:

main

public static void main(String[] args)
                 throws org.apache.commons.cli.ParseException,
                        MalformedURLException,
                        IllegalArgumentException,
                        IllegalAccessException,
                        NoSuchFieldException,
                        SecurityException,
                        InstantiationException,
                        InvocationTargetException,
                        NoSuchMethodException,
                        ClassNotFoundException

Run the interface report generation. use -h argument for help and argument list.

Parameters:

args - the command line arguments.

Throws:

org.apache.commons.cli.ParseException

MalformedURLException

ClassNotFoundException

NoSuchMethodException

InvocationTargetException

InstantiationException

SecurityException

NoSuchFieldException

IllegalAccessException

IllegalArgumentException