capital.scalable.restdocs.request

Class RequestParametersSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

capital.scalable.restdocs.snippet.StandardTableSnippet

capital.scalable.restdocs.request.RequestParametersSnippet

All Implemented Interfaces:

SectionSupport, org.springframework.restdocs.snippet.Snippet

public class RequestParametersSnippet
extends StandardTableSnippet

Field Summary

Fields

Modifier and Type	Field and Description
static String	SPRING_DATA_PAGEABLE_CLASS

Constructor Summary

Constructors

Constructor and Description
RequestParametersSnippet()
RequestParametersSnippet(boolean failOnUndocumentedParams)

Method Summary

Modifier and Type	Method and Description
protected org.springframework.restdocs.snippet.Attributes.Attribute	constraintAttribute(org.springframework.core.MethodParameter param, ConstraintReader constraintReader)
protected FieldDescriptors	createFieldDescriptors(org.springframework.restdocs.operation.Operation operation, org.springframework.web.method.HandlerMethod handlerMethod)
protected org.springframework.restdocs.snippet.Attributes.Attribute	defaultValueAttribute(A annot)
protected org.springframework.restdocs.snippet.Attributes.Attribute	deprecatedAttribute(org.springframework.core.MethodParameter param, A annot, JavadocReader javadocReader)
protected void	enrichModel(Map<String,Object> model, org.springframework.web.method.HandlerMethod handlerMethod, FieldDescriptors fieldDescriptors)
RequestParametersSnippet	failOnUndocumentedParams(boolean failOnUndocumentedParams)
protected org.springframework.web.bind.annotation.RequestParam	getAnnotation(org.springframework.core.MethodParameter param)
protected String	getDefaultValue(org.springframework.web.bind.annotation.RequestParam annotation)
String	getFileName() File name (= section name).
String	getHeaderKey() Section header key corresponding to entry in translation file.
protected String	getPath(org.springframework.web.bind.annotation.RequestParam annot)
protected String[]	getTranslationKeys()
boolean	hasContent(org.springframework.restdocs.operation.Operation operation) Flag if section will render non-empty content.
protected boolean	isCustomDefaultValue(String defaultValue)
protected boolean	isRequired(org.springframework.core.MethodParameter param, org.springframework.web.bind.annotation.RequestParam annot)
protected org.springframework.restdocs.snippet.Attributes.Attribute	optionalsAttribute(org.springframework.core.MethodParameter param, A annot)
protected boolean	shouldFailOnUndocumentedParams()

Methods inherited from class capital.scalable.restdocs.snippet.StandardTableSnippet

createModel, createModelForDescriptor

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

Field Detail

SPRING_DATA_PAGEABLE_CLASS

public static final String SPRING_DATA_PAGEABLE_CLASS

See Also:

Constant Field Values

Constructor Detail

RequestParametersSnippet

public RequestParametersSnippet()

RequestParametersSnippet

public RequestParametersSnippet(boolean failOnUndocumentedParams)

Method Detail

failOnUndocumentedParams

public RequestParametersSnippet failOnUndocumentedParams(boolean failOnUndocumentedParams)

isRequired

protected boolean isRequired(org.springframework.core.MethodParameter param,
                             org.springframework.web.bind.annotation.RequestParam annot)

getPath

protected String getPath(org.springframework.web.bind.annotation.RequestParam annot)

getAnnotation

protected org.springframework.web.bind.annotation.RequestParam getAnnotation(org.springframework.core.MethodParameter param)

enrichModel

protected void enrichModel(Map<String,Object> model,
                           org.springframework.web.method.HandlerMethod handlerMethod,
                           FieldDescriptors fieldDescriptors)

Overrides:

enrichModel in class StandardTableSnippet

getHeaderKey

public String getHeaderKey()

Description copied from interface: SectionSupport

Section header key corresponding to entry in translation file.

shouldFailOnUndocumentedParams

protected boolean shouldFailOnUndocumentedParams()

getDefaultValue

protected String getDefaultValue(org.springframework.web.bind.annotation.RequestParam annotation)

getTranslationKeys

protected String[] getTranslationKeys()

Specified by:

getTranslationKeys in class StandardTableSnippet

createFieldDescriptors

protected FieldDescriptors createFieldDescriptors(org.springframework.restdocs.operation.Operation operation,
                                                  org.springframework.web.method.HandlerMethod handlerMethod)

Specified by:

createFieldDescriptors in class StandardTableSnippet

isCustomDefaultValue

protected boolean isCustomDefaultValue(String defaultValue)

constraintAttribute

protected org.springframework.restdocs.snippet.Attributes.Attribute constraintAttribute(org.springframework.core.MethodParameter param,
                                                                                        ConstraintReader constraintReader)

optionalsAttribute

protected org.springframework.restdocs.snippet.Attributes.Attribute optionalsAttribute(org.springframework.core.MethodParameter param,
                                                                                       A annot)

deprecatedAttribute

protected org.springframework.restdocs.snippet.Attributes.Attribute deprecatedAttribute(org.springframework.core.MethodParameter param,
                                                                                        A annot,
                                                                                        JavadocReader javadocReader)

defaultValueAttribute

protected org.springframework.restdocs.snippet.Attributes.Attribute defaultValueAttribute(A annot)

getFileName

public String getFileName()

Description copied from interface: SectionSupport

File name (= section name).

Specified by:

getFileName in interface SectionSupport

hasContent

public boolean hasContent(org.springframework.restdocs.operation.Operation operation)

Description copied from interface: SectionSupport

Flag if section will render non-empty content.

Specified by:

hasContent in interface SectionSupport

Parameters:

operation - operation

Returns:

true if snippet will return non-empty content; false otherwise