org.xenei.junit.contract.info

Class ContractTestMap

java.lang.Object

org.xenei.junit.contract.info.ContractTestMap

public class ContractTestMap
extends Object

A map like object that maintains information about test classes and the classes they test.

Constructor Summary

Constructors

Constructor and Description
ContractTestMap()

Method Summary

Modifier and Type	Method and Description
void	add(TestInfo info) Add a TestInfo to the map.
Set<TestInfo>	getAnnotatedClasses(Set<TestInfo> testClasses, TestInfo contractClassInfo) Find the test classes for the specific contract class.
Set<TestInfo>	getAnnotatedClasses(TestInfo contractClassInfo) Find the test classes for the specific contract class.
Set<TestInfo>	getInfoByInterfaceClass(Class<?> contract) Get a TestInfo for a interface under test.
TestInfo	getInfoByTestClass(Class<?> testClass) Get a TestInfo for the test class.
Collection<TestInfo>	listTestInfo() A list of all test Infos.
static ContractTestMap	populateInstance() Populate and return a ContractTestMap with all the contract tests on the class path.
static ContractTestMap	populateInstance(ClassLoader classLoader) Populate and return a ContractTestMap with all the contract tests on the classpath.
static ContractTestMap	populateInstance(ClassLoader classLoader, String[] packages)

Methods inherited from class java.lang.Object

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

Constructor Detail

ContractTestMap

public ContractTestMap()

Method Detail

populateInstance

public static ContractTestMap populateInstance()

Populate and return a ContractTestMap with all the contract tests on the class path. Will add to list of errors for tests that do not have proper annotations.

Parameters:

errors - A list of errors.

Returns:

contractTestClasses TestInfo objects for classes annotated with @Contract

populateInstance

public static ContractTestMap populateInstance(ClassLoader classLoader)

Populate and return a ContractTestMap with all the contract tests on the classpath. Will add to list of errors for tests that do not have proper annotations.

Parameters:

classLoader - The class loader to load classes from.

Returns:

contractTestClasses TestInfo objects for classes annotated with @Contract

populateInstance

public static ContractTestMap populateInstance(ClassLoader classLoader,
                                               String[] packages)

Parameters:

classLoader - The class loader to use.

packages - A list of package names to report

Returns:

A ContractTestMap.

add

public void add(TestInfo info)

Add a TestInfo to the map.

Parameters:

info - the info to add

getInfoByTestClass

public TestInfo getInfoByTestClass(Class<?> testClass)

Get a TestInfo for the test class.

Parameters:

testClass - The test class.

Returns:

THe TestInfo for the test class.

getInfoByInterfaceClass

public Set<TestInfo> getInfoByInterfaceClass(Class<?> contract)

Get a TestInfo for a interface under test.

Parameters:

contract - The class (interface) under tes.t

Returns:

The TestInfo for the contract class.

getAnnotatedClasses

public Set<TestInfo> getAnnotatedClasses(TestInfo contractClassInfo)

Find the test classes for the specific contract class.

Parameters:

contractClassInfo - A TestInfo object that represents the test class to search for.

Returns:

the set of TestInfo objects that represent the complete suite of contract tests for the contractClassInfo object.

getAnnotatedClasses

public Set<TestInfo> getAnnotatedClasses(Set<TestInfo> testClasses,
                                         TestInfo contractClassInfo)

Find the test classes for the specific contract class. Adds the results to the testClasses parameter set.

Parameters:

testClasses - A set of testInfo to add the result to.

contractClassInfo - A TestInfo object that represents the test class to search for.

Returns:

the set of TestInfo objects that represent the complete suite of contract tests for the contractClassInfo object.

listTestInfo

public Collection<TestInfo> listTestInfo()

A list of all test Infos.

Returns: