Package org.springframework.cloud.contract.spec.internal

Class Common

java.lang.Object

org.springframework.cloud.contract.spec.internal.Common

Direct Known Subclasses:

Input, OutputMessage, Request, Response

public class Common
extends Object

Contains useful common methods for the DSL.

Since:

1.0.0

Author:

Marcin Grzejszczak, Olga Maciaszek-Sharma, Tim Ysewyn

Constructor Summary

Constructors

Constructor	Description
Common()

Method Summary

Modifier and Type	Method	Description
DslProperty	$(Object value)
DslProperty	$(ClientDslProperty client, ServerDslProperty server)
DslProperty	$(DslProperty value)
DslProperty	$(ServerDslProperty server, ClientDslProperty client)
RegexProperty	aDouble()
RegexProperty	alphaNumeric()
RegexProperty	anInteger()
RegexProperty	anyBoolean()
void	assertThatSidesMatch(Object firstSide, Object secondSide)
ClientDslProperty	c(Object clientValue)	Helper method to provide a better name for the consumer side.
ClientDslProperty	client(Object clientValue)	Helper method to provide a better name for the consumer side.
ClientDslProperty	consumer(Object clientValue)	Helper method to provide a better name for the consumer side.
Collection	convertObjectsToDslProperties(List<Object> body)
Map<String,DslProperty>	convertObjectsToDslProperties(Map<String,Object> body)
RegexProperty	email()
ExecutionProperty	execute(String commandToExecute)
FromFileProperty	file(String relativePath)	Read file contents as String.
FromFileProperty	file(String relativePath, Charset charset)	Read file contents as String with the given Charset.
FromFileProperty	fileAsBytes(String relativePath)	Read file contents as bytes[].
RegexProperty	hostname()
RegexProperty	httpsUrl()
RegexProperty	ipAddress()
RegexProperty	iso8601WithOffset()
RegexProperty	isoDate()
RegexProperty	isoDateTime()
RegexProperty	isoTime()
NamedProperty	named(Map<String,DslProperty> namedMap)
NamedProperty	named(DslProperty name, DslProperty value)
NamedProperty	named(DslProperty name, DslProperty value, DslProperty contentType)
RegexProperty	nonBlank()
RegexProperty	nonEmpty()
RegexProperty	number()
RegexProperty	onlyAlphaUnicode()
OptionalProperty	optional(Object object)
ServerDslProperty	p(Object serverValue)	Helper method to provide a better name for the server side.
RegexProperty	positiveInt()
ServerDslProperty	producer(Object serverValue)	Helper method to provide a better name for the server side.
RegexProperty	regex(String regex)
RegexProperty	regex(Pattern regex)
RegexProperty	regex(RegexProperty regex)
RegexProperty	regexProperty(Object object)
ServerDslProperty	server(Object serverValue)	Helper method to provide a better name for the server side.
ClientDslProperty	stub(Object clientValue)	Helper method to provide a better name for the consumer side.
ServerDslProperty	test(Object serverValue)	Helper method to provide a better name for the server side.
DslProperty	toDslProperty(Object property)
DslProperty	toDslProperty(List property)
DslProperty	toDslProperty(Map property)
DslProperty	toDslProperty(DslProperty property)
RegexProperty	url()
RegexProperty	uuid()
DslProperty	value(Object value)
DslProperty	value(ClientDslProperty client, ServerDslProperty server)
DslProperty	value(DslProperty value)
DslProperty	value(ServerDslProperty server, ClientDslProperty client)

Methods inherited from class java.lang.Object

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

Constructor Details

Common

public Common()

Method Details

convertObjectsToDslProperties

public Map<String,DslProperty> convertObjectsToDslProperties(Map<String,Object> body)

convertObjectsToDslProperties

public Collection convertObjectsToDslProperties(List<Object> body)

toDslProperty

public DslProperty toDslProperty(Object property)

toDslProperty

public DslProperty toDslProperty(Map property)

toDslProperty

public DslProperty toDslProperty(List property)

toDslProperty

public DslProperty toDslProperty(DslProperty property)

named

public NamedProperty named(DslProperty name,
 DslProperty value)

named

public NamedProperty named(DslProperty name,
 DslProperty value,
 DslProperty contentType)

named

public NamedProperty named(Map<String,DslProperty> namedMap)

value

public DslProperty value(DslProperty value)

$

public DslProperty $(DslProperty value)

value

public DslProperty value(Object value)

$

public DslProperty $(Object value)

value

public DslProperty value(ClientDslProperty client,
 ServerDslProperty server)

$

public DslProperty $(ClientDslProperty client,
 ServerDslProperty server)

value

public DslProperty value(ServerDslProperty server,
 ClientDslProperty client)

$

public DslProperty $(ServerDslProperty server,
 ClientDslProperty client)

regex

public RegexProperty regex(String regex)

regex

public RegexProperty regex(RegexProperty regex)

regex

public RegexProperty regex(Pattern regex)

optional

public OptionalProperty optional(Object object)

regexProperty

public RegexProperty regexProperty(Object object)

execute

public ExecutionProperty execute(String commandToExecute)

client

public ClientDslProperty client(Object clientValue)

Helper method to provide a better name for the consumer side.

Parameters:

clientValue - client value

Returns:

client dsl property

stub

public ClientDslProperty stub(Object clientValue)

Helper method to provide a better name for the consumer side.

Parameters:

clientValue - client value

Returns:

client dsl property

consumer

public ClientDslProperty consumer(Object clientValue)

Helper method to provide a better name for the consumer side.

Parameters:

clientValue - client value

Returns:

client dsl property

server

public ServerDslProperty server(Object serverValue)

Helper method to provide a better name for the server side.

Parameters:

serverValue - server value

Returns:

server dsl property

c

public ClientDslProperty c(Object clientValue)

Helper method to provide a better name for the consumer side.

Parameters:

clientValue - client value

Returns:

client dsl property

p

public ServerDslProperty p(Object serverValue)

Helper method to provide a better name for the server side.

Parameters:

serverValue - server value

Returns:

server dsl property

test

public ServerDslProperty test(Object serverValue)

Helper method to provide a better name for the server side.

Parameters:

serverValue - server value

Returns:

server dsl property

file

public FromFileProperty file(String relativePath)

Read file contents as String.

Parameters:

relativePath - of the file to read

Returns:

String file contents

fileAsBytes

public FromFileProperty fileAsBytes(String relativePath)

Read file contents as bytes[].

Parameters:

relativePath - of the file to read

Returns:

String file contents

file

public FromFileProperty file(String relativePath,
 Charset charset)

Read file contents as String with the given Charset.

Parameters:

relativePath - of the file to read

charset - to use for converting the bytes to String

Returns:

String file contents

producer

public ServerDslProperty producer(Object serverValue)

Helper method to provide a better name for the server side.

Parameters:

serverValue - server value

Returns:

server dsl property

assertThatSidesMatch

public void assertThatSidesMatch(Object firstSide,
 Object secondSide)

onlyAlphaUnicode

public RegexProperty onlyAlphaUnicode()

alphaNumeric

public RegexProperty alphaNumeric()

number

public RegexProperty number()

positiveInt

public RegexProperty positiveInt()

anyBoolean

public RegexProperty anyBoolean()

anInteger

public RegexProperty anInteger()

aDouble

public RegexProperty aDouble()

ipAddress

public RegexProperty ipAddress()

hostname

public RegexProperty hostname()

email

public RegexProperty email()

url

public RegexProperty url()

httpsUrl

public RegexProperty httpsUrl()

uuid

public RegexProperty uuid()

isoDate

public RegexProperty isoDate()

isoDateTime

public RegexProperty isoDateTime()

isoTime

public RegexProperty isoTime()

iso8601WithOffset

public RegexProperty iso8601WithOffset()

nonEmpty

public RegexProperty nonEmpty()

nonBlank

public RegexProperty nonBlank()