Package springfox.documentation.service

Class RequestParameter

java.lang.Object

springfox.documentation.service.RequestParameter

public class RequestParameter
extends java.lang.Object

Since:

3.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
RequestParameter(java.lang.String name, ParameterType in, java.lang.String description, java.lang.Boolean required, java.lang.Boolean deprecated, java.lang.Boolean hidden, ParameterSpecification parameterSpecification, Example scalarExample, java.util.Collection<Example> examples, int precedence, java.util.List<VendorExtension> extensions, int parameterIndex)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.lang.Boolean	getDeprecated()
java.lang.String	getDescription()
java.util.List<Example>	getExamples()
java.util.List<VendorExtension>	getExtensions()
java.lang.Boolean	getHidden()
ParameterType	getIn()
java.lang.String	getName()
int	getParameterIndex()
ParameterSpecification	getParameterSpecification()
java.lang.Integer	getPrecedence()
java.lang.Boolean	getRequired()
Example	getScalarExample()
int	hashCode()
boolean	isRequestBody()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_PRECEDENCE

public static final int DEFAULT_PRECEDENCE

See Also:

Constant Field Values

Constructor Detail

RequestParameter

public RequestParameter(java.lang.String name,
                        ParameterType in,
                        java.lang.String description,
                        java.lang.Boolean required,
                        java.lang.Boolean deprecated,
                        java.lang.Boolean hidden,
                        ParameterSpecification parameterSpecification,
                        Example scalarExample,
                        java.util.Collection<Example> examples,
                        int precedence,
                        java.util.List<VendorExtension> extensions,
                        int parameterIndex)

Method Detail

getName

public java.lang.String getName()

getIn

public ParameterType getIn()

getDescription

public java.lang.String getDescription()

getRequired

public java.lang.Boolean getRequired()

getDeprecated

public java.lang.Boolean getDeprecated()

getParameterSpecification

public ParameterSpecification getParameterSpecification()

getExtensions

public java.util.List<VendorExtension> getExtensions()

getPrecedence

public java.lang.Integer getPrecedence()

getExamples

public java.util.List<Example> getExamples()

getScalarExample

public Example getScalarExample()

isRequestBody

public boolean isRequestBody()

getParameterIndex

public int getParameterIndex()

getHidden

public java.lang.Boolean getHidden()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object