org.springframework.restdocs.request

Class AbstractParametersSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

org.springframework.restdocs.request.AbstractParametersSnippet

All Implemented Interfaces:

Snippet

Direct Known Subclasses:

PathParametersSnippet, RequestParametersSnippet

public abstract class AbstractParametersSnippet
extends TemplatedSnippet

Abstract TemplatedSnippet subclass that provides a base for snippets that document parameters from a request sent to a RESTful resource.

Author:

Andreas Evers, Andy Wilkinson

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractParametersSnippet(java.lang.String snippetName, java.util.List<ParameterDescriptor> descriptors, java.util.Map<java.lang.String,java.lang.Object> attributes, boolean ignoreUndocumentedParameters) Creates a new AbstractParametersSnippet that will produce a snippet with the given snippetName that will document parameters using the given descriptors.

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	createModel(Operation operation) Create the model that should be used during template rendering to document the given operation.
protected java.util.Map<java.lang.String,java.lang.Object>	createModelForDescriptor(ParameterDescriptor descriptor) Returns a model for the given descriptor.
protected abstract java.util.Set<java.lang.String>	extractActualParameters(Operation operation) Extracts the names of the parameters that were present in the given operation.
protected java.util.Map<java.lang.String,ParameterDescriptor>	getParameterDescriptors() Returns a Map of ParameterDescriptors that will be used to generate the documentation key by their ParameterDescriptor.getName().
protected abstract void	verificationFailed(java.util.Set<java.lang.String> undocumentedParameters, java.util.Set<java.lang.String> missingParameters) Called when the documented parameters do not match the actual parameters.

Methods inherited from class org.springframework.restdocs.snippet.TemplatedSnippet

document, getAttributes, getSnippetName

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractParametersSnippet

protected AbstractParametersSnippet(java.lang.String snippetName,
                                    java.util.List<ParameterDescriptor> descriptors,
                                    java.util.Map<java.lang.String,java.lang.Object> attributes,
                                    boolean ignoreUndocumentedParameters)

Creates a new AbstractParametersSnippet that will produce a snippet with the given snippetName that will document parameters using the given descriptors. The given attributes will be included in the model during template rendering. If ignoreUndocumentedParameters is true, undocumented parameters will be ignored and will not trigger a failure.

Parameters:

snippetName - The snippet name

descriptors - The descriptors

attributes - The additional attributes

ignoreUndocumentedParameters - whether undocumented parameters should be ignored

Method Detail

createModel

protected java.util.Map<java.lang.String,java.lang.Object> createModel(Operation operation)

Description copied from class: TemplatedSnippet

Create the model that should be used during template rendering to document the given operation. Any additional attributes that were supplied when this TemplatedSnippet were created will be automatically added to the model prior to rendering.

Specified by:

createModel in class TemplatedSnippet

Parameters:

operation - The operation

Returns:

the model

extractActualParameters

protected abstract java.util.Set<java.lang.String> extractActualParameters(Operation operation)

Extracts the names of the parameters that were present in the given operation.

Parameters:

operation - the operation

Returns:

the parameters

verificationFailed

protected abstract void verificationFailed(java.util.Set<java.lang.String> undocumentedParameters,
                                           java.util.Set<java.lang.String> missingParameters)

Called when the documented parameters do not match the actual parameters.

Parameters:

undocumentedParameters - the parameters that were found in the operation but were not documented

missingParameters - the parameters that were documented but were not found in the operation

getParameterDescriptors

protected final java.util.Map<java.lang.String,ParameterDescriptor> getParameterDescriptors()

Returns a Map of ParameterDescriptors that will be used to generate the documentation key by their ParameterDescriptor.getName().

Returns:

the map of path descriptors

createModelForDescriptor

protected java.util.Map<java.lang.String,java.lang.Object> createModelForDescriptor(ParameterDescriptor descriptor)

Returns a model for the given descriptor.

Parameters:

descriptor - the descriptor

Returns:

the model