org.xenei.junit.contract

Annotation Type ContractImpl

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface ContractImpl

Annotation to declare the type the ContractSuite is testing.

For example

 
 @RunWith( ContractSuite.class )
 @ContractImpl( FooImpl.class ) public class Foo_Test {...}
 

Declares FooImpl as the implementation that the contract suite should be built for.

The value of the annotation (FooImpl.class) in the above example) defines the class that will be scanned for interfaces. The set of contract tests are then scanned looking for tests for those interfaces. Tests from all matching Contract tests are then added to the current test class.

NOTE: In some cases only the interface is known, not the implementation. In these cases a testing interface may be created and that class used in the ContractImpl annotation. For example assume that you want to test an interface A. create an interface: interface ATester extends A{}; and in the ContractImpl annotation use ATester.class

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<?>	value The Implementation class that should be scanned for interfaces that have Contract tests defined.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>[]	ignore The list of implementations to skip.
Class<?>[]	skip The list of interface classes for which tests should be skipped.

Element Detail

value

public abstract Class<?> value

The Implementation class that should be scanned for interfaces that have Contract tests defined.

Returns:

The class the implementation class.

skip

public abstract Class<?>[] skip

The list of interface classes for which tests should be skipped.

Returns:

The interfaces to skip.

Default:

{}

ignore

public abstract Class<?>[] ignore

The list of implementations to skip. These are implementations of interface tests.

Returns:

the list of interface test implementations to skip.

Default:

{}