org.springframework.cloud.contract.verifier.config.framework

Class CustomDefinition

java.lang.Object

org.springframework.cloud.contract.verifier.config.framework.CustomDefinition

All Implemented Interfaces:

TestFrameworkDefinition

public class CustomDefinition
extends Object
implements TestFrameworkDefinition

Defines elements characteristic of Custom test framework to be used during test class construction.

Since:

2.1.0

Author:

Olga Maciaszek-Sharma

Constructor Summary

Constructors

Constructor and Description
CustomDefinition()

Method Summary

Modifier and Type	Method and Description
boolean	annotationLevelRules()
String	getClassExtension()
String	getClassModifier()
String	getClassNameSuffix()
String	getIgnoreAnnotation()
String	getIgnoreClass()
String	getLineSuffix()
String	getMethodModifier()
String	getOrderAnnotation()
List<String>	getOrderAnnotationImports()
String	getRuleAnnotation(String annotationValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomDefinition

public CustomDefinition()

Method Detail

getClassModifier

public String getClassModifier()

Specified by:

getClassModifier in interface TestFrameworkDefinition

Returns:

the class access level modifier. E.g. for Java tests that would mean public

getMethodModifier

public String getMethodModifier()

Specified by:

getMethodModifier in interface TestFrameworkDefinition

Returns:

the method access level modifier along with the return type. E.g. for Java tests that would mean public void

getLineSuffix

public String getLineSuffix()

Specified by:

getLineSuffix in interface TestFrameworkDefinition

Returns:

the characters that should end each line. E.g. for Java tests that would mean ;

getClassExtension

public String getClassExtension()

Specified by:

getClassExtension in interface TestFrameworkDefinition

Returns:

the file extension. E.g. for Java tests that would be .java

getClassNameSuffix

public String getClassNameSuffix()

Specified by:

getClassNameSuffix in interface TestFrameworkDefinition

Returns:

the test class name suffix. E.g. for JUnit tests that would be Test

getIgnoreClass

public String getIgnoreClass()

Specified by:

getIgnoreClass in interface TestFrameworkDefinition

Returns:

the qualified name of the class used to ignore or disable tests. E.g. for JUnit 4 tests that would be org.junit.Ignore

getOrderAnnotationImports

public List<String> getOrderAnnotationImports()

Specified by:

getOrderAnnotationImports in interface TestFrameworkDefinition

Returns:

the qualified names of the classes that are used for arranging tests into scenarios. E.g. for JUnit 4 tests that would be 'org.junit.FixMethodOrder', 'org.junit.runners.MethodSorters'

getOrderAnnotation

public String getOrderAnnotation()

Specified by:

getOrderAnnotation in interface TestFrameworkDefinition

Returns:

the annotation used for arranging tests into scenarios. E.g. for JUnit test that would be @FixMethodOrder(MethodSorters.NAME_ASCENDING)

getIgnoreAnnotation

public String getIgnoreAnnotation()

Specified by:

getIgnoreAnnotation in interface TestFrameworkDefinition

Returns:

the annotation used for ignoring or disabling tests. E.g. for JUnit tests that would mean @Ignore

annotationLevelRules

public boolean annotationLevelRules()

Specified by:

annotationLevelRules in interface TestFrameworkDefinition

Returns:

a boolean indicating whether an annotation-type rule or extension is being used or not. E.g. for JUnit 5 tests that would return true

getRuleAnnotation

public String getRuleAnnotation(String annotationValue)

Specified by:

getRuleAnnotation in interface TestFrameworkDefinition

Parameters:

annotationValue - value of the annotation

Returns:

the test rule or extension annotation with the passed as an argument. E.g. for JUnit 5 tests that could be @ExtendWith(Example.class)