org.springframework.restdocs

Class RestDocumentationContext

java.lang.Object

org.springframework.restdocs.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

Constructor Summary

Constructors

Constructor and Description
RestDocumentationContext(Class<?> testClass, String testMethodName, File outputDirectory) Deprecated. Since 1.1 in favor of ManualRestDocumentation.

Method Summary

Modifier and Type	Method and Description
File	getOutputDirectory() Returns the output directory to which generated snippets should be written.
int	getStepCount() Returns the current step count.
Class<?>	getTestClass() Returns the class whose tests are currently executing.
String	getTestMethodName() Returns the name of 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

Constructor Detail

RestDocumentationContext

@Deprecated
public RestDocumentationContext(Class<?> testClass,
                                            String testMethodName,
                                            File outputDirectory)

Deprecated. Since 1.1 in favor of ManualRestDocumentation.

Creates a new RestDocumentationContext for a test on the given testClass with given testMethodName that will generate documentation to the given outputDirectory.

Parameters:

testClass - the class whose test is being executed

testMethodName - the name of the test method that is being executed

outputDirectory - the directory to which documentation should be written.

Method Detail

getTestClass

public Class<?> getTestClass()

Returns the class whose tests are currently executing.

Returns:

The test class

getTestMethodName

public String getTestMethodName()

Returns the name of the test method that is currently executing.

Returns:

The name of the test method

getStepCount

public int getStepCount()

Returns the current step count.

Returns:

The current step count

getOutputDirectory

public File getOutputDirectory()

Returns the output directory to which generated snippets should be written.

Returns:

the output directory