org.springframework.cloud.contract.verifier.dsl

Class ContractVerifierMetadata

java.lang.Object

org.springframework.cloud.contract.verifier.dsl.ContractVerifierMetadata

All Implemented Interfaces:

SpringCloudContractMetadata

public class ContractVerifierMetadata
extends Object
implements SpringCloudContractMetadata

Metadata representation of the Contract Verifier.

Since:

3.0.0

Author:

Marcin Grzejszczak

Field Summary

Fields

Modifier and Type	Field and Description
static String	METADATA_KEY Metadata entry in the contract.

Constructor Summary

Constructors

Constructor and Description
ContractVerifierMetadata()
ContractVerifierMetadata(String tool)

Method Summary

Modifier and Type	Method and Description
String	description() Short description of the metadata.
static ContractVerifierMetadata	fromMetadata(Map<String,Object> metadata)
String	getTool()
String	key() Name of the key under which this metadata entry will be present in contract's metadata.
void	setTool(String tool)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cloud.contract.verifier.util.SpringCloudContractMetadata

additionalClassesToLookAt

Field Detail

METADATA_KEY

public static final String METADATA_KEY

Metadata entry in the contract.

See Also:

Constant Field Values

Constructor Detail

ContractVerifierMetadata

public ContractVerifierMetadata(String tool)

ContractVerifierMetadata

public ContractVerifierMetadata()

Method Detail

getTool

public String getTool()

setTool

public void setTool(String tool)

fromMetadata

@NonNull
public static ContractVerifierMetadata fromMetadata(Map<String,Object> metadata)

key

public String key()

Description copied from interface: SpringCloudContractMetadata

Name of the key under which this metadata entry will be present in contract's metadata.

Specified by:

key in interface SpringCloudContractMetadata

Returns:

key name

description

public String description()

Description copied from interface: SpringCloudContractMetadata

Short description of the metadata. Will be used in the generated documentation.

Specified by:

description in interface SpringCloudContractMetadata

Returns:

description of the metadata.