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 name of the current test method formatted using camelCase
• 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

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
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