org.springframework.cloud.contract.verifier.messaging.internal

Class ContractVerifierMessageMetadata

java.lang.Object

org.springframework.cloud.contract.verifier.messaging.internal.ContractVerifierMessageMetadata

All Implemented Interfaces:

SpringCloudContractMetadata

public class ContractVerifierMessageMetadata
extends Object
implements SpringCloudContractMetadata

Metadata representation of the Contract Verifier messaging.

Since:

3.0.0

Author:

Marcin Grzejszczak

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContractVerifierMessageMetadata.MessageType Type of a message.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ContractVerifierMessageMetadata()
ContractVerifierMessageMetadata(ContractVerifierMessageMetadata.MessageType messageType)

Method Summary

Modifier and Type	Method and Description
String	description() Short description of the metadata.
static ContractVerifierMessageMetadata	fromMetadata(Map<String,Object> metadata)
ContractVerifierMessageMetadata.MessageType	getMessageType()
String	key() Name of the key under which this metadata entry will be present in contract's metadata.
void	setMessageType(ContractVerifierMessageMetadata.MessageType messageType)

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

ContractVerifierMessageMetadata

public ContractVerifierMessageMetadata(ContractVerifierMessageMetadata.MessageType messageType)

ContractVerifierMessageMetadata

public ContractVerifierMessageMetadata()

Method Detail

getMessageType

public ContractVerifierMessageMetadata.MessageType getMessageType()

setMessageType

public void setMessageType(ContractVerifierMessageMetadata.MessageType messageType)

fromMetadata

public static ContractVerifierMessageMetadata 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.