org.springframework.restdocs.snippet

Class RestDocumentationContextPlaceholderResolver

java.lang.Object

org.springframework.restdocs.snippet.RestDocumentationContextPlaceholderResolver

All Implemented Interfaces:

PropertyPlaceholderHelper.PlaceholderResolver

public class RestDocumentationContextPlaceholderResolver
extends Object
implements PropertyPlaceholderHelper.PlaceholderResolver

A PropertyPlaceholderHelper.PlaceholderResolver that resolves placeholders using a RestDocumentationContext. The following placeholders are supported:

• step - the step current count.
• methodName - the unmodified name of the current test method without applying any formatting
• method-name - the name of the current test method formatted using kebab-case
• method_name - the name of the current test method formatted using snake_case
• ClassName - the unmodified simple name of the current test class
• class-name - the simple name of the current test class formatted using kebab-case
• class_name - the simple name of the current test class formatted using snake case

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
RestDocumentationContextPlaceholderResolver(RestDocumentationContext context) Creates a new placeholder resolver that will resolve placeholders using the given context.

Method Summary

Modifier and Type	Method and Description
protected String	camelCaseToKebabCase(String string) Converts the given string from camelCase to kebab-case.
protected String	camelCaseToSnakeCase(String string) Converts the given string from camelCase to snake_case.
protected RestDocumentationContext	getContext() Returns the RestDocumentationContext that should be used during placeholder resolution.
String	resolvePlaceholder(String placeholderName)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestDocumentationContextPlaceholderResolver

public RestDocumentationContextPlaceholderResolver(RestDocumentationContext context)

Creates a new placeholder resolver that will resolve placeholders using the given context.

Parameters:

context - the context to use

Method Detail

resolvePlaceholder

public String resolvePlaceholder(String placeholderName)

Specified by:

resolvePlaceholder in interface PropertyPlaceholderHelper.PlaceholderResolver

camelCaseToKebabCase

protected final String camelCaseToKebabCase(String string)

Converts the given string from camelCase to kebab-case.

Parameters:

string - the string

Returns:

the converted string

camelCaseToSnakeCase

protected final String camelCaseToSnakeCase(String string)

Converts the given string from camelCase to snake_case.

Parameters:

string - the string

Returns:

the converted string

getContext

protected final RestDocumentationContext getContext()

Returns the RestDocumentationContext that should be used during placeholder resolution.

Returns:

the context