org.springframework.restdocs.config

Class RestDocumentationContext

java.lang.Object

org.springframework.restdocs.config.RestDocumentationContext

public final class RestDocumentationContext
extends Object

RestDocumentationContext encapsulates the context in which the documentation of a RESTful API is being performed.

Author:

Andy Wilkinson

Method Summary

Modifier and Type	Method and Description
static RestDocumentationContext	currentContext() Returns the current context, never null.
String	getSnippetEncoding() Gets the encoding to be used when writing snippets
int	getStepCount() Gets the current step count
Method	getTestMethod() Returns the test method that is currently executing

Methods inherited from class java.lang.Object

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

Method Detail

getTestMethod

public Method getTestMethod()

Returns the test method that is currently executing

Returns:

The test method

getStepCount

public int getStepCount()

Gets the current step count

Returns:

The current step count

getSnippetEncoding

public String getSnippetEncoding()

Gets the encoding to be used when writing snippets

Returns:

The snippet encoding

currentContext

public static RestDocumentationContext currentContext()

Returns the current context, never null.

Returns:

The current context