springfox.documentation.service

Class Parameter

java.lang.Object

springfox.documentation.service.Parameter

All Implemented Interfaces:

org.springframework.core.Ordered

public class Parameter
extends java.lang.Object
implements org.springframework.core.Ordered

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PRECEDENCE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description

Parameter(java.lang.String name, java.lang.String description, java.lang.String defaultValue, boolean required, boolean allowMultiple, java.lang.Boolean allowEmptyValue, ModelReference modelRef, com.google.common.base.Optional<com.fasterxml.classmate.ResolvedType> type, AllowableValues allowableValues, java.lang.String paramType, java.lang.String paramAccess, boolean hidden, java.lang.String pattern, java.lang.String collectionFormat, int order, java.lang.Object scalarExample, com.google.common.collect.Multimap<java.lang.String,Example> examples, java.util.List<VendorExtension> vendorExtensions)

Method Summary

Modifier and Type	Method and Description
AllowableValues	getAllowableValues()
java.lang.String	getCollectionFormat()
java.lang.String	getDefaultValue()
java.lang.String	getDescription()
com.google.common.collect.Multimap<java.lang.String,Example>	getExamples()
ModelReference	getModelRef()
java.lang.String	getName()
int	getOrder()
java.lang.String	getParamAccess()
java.lang.String	getParamType()
java.lang.String	getPattern()
java.lang.Object	getScalarExample()
com.google.common.base.Optional<com.fasterxml.classmate.ResolvedType>	getType()
java.util.List<VendorExtension>	getVendorExtentions()
java.lang.Boolean	isAllowEmptyValue()
java.lang.Boolean	isAllowMultiple()
java.lang.Boolean	isHidden()
java.lang.Boolean	isRequired()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PRECEDENCE

public static final int DEFAULT_PRECEDENCE

See Also:

Constant Field Values

Constructor Detail

Parameter

public Parameter(java.lang.String name,
                 java.lang.String description,
                 java.lang.String defaultValue,
                 boolean required,
                 boolean allowMultiple,
                 java.lang.Boolean allowEmptyValue,
                 ModelReference modelRef,
                 com.google.common.base.Optional<com.fasterxml.classmate.ResolvedType> type,
                 AllowableValues allowableValues,
                 java.lang.String paramType,
                 java.lang.String paramAccess,
                 boolean hidden,
                 java.lang.String pattern,
                 java.lang.String collectionFormat,
                 int order,
                 java.lang.Object scalarExample,
                 com.google.common.collect.Multimap<java.lang.String,Example> examples,
                 java.util.List<VendorExtension> vendorExtensions)

Method Detail

getType

public com.google.common.base.Optional<com.fasterxml.classmate.ResolvedType> getType()

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getDefaultValue

public java.lang.String getDefaultValue()

isRequired

public java.lang.Boolean isRequired()

isAllowMultiple

public java.lang.Boolean isAllowMultiple()

getAllowableValues

public AllowableValues getAllowableValues()

getParamType

public java.lang.String getParamType()

getParamAccess

public java.lang.String getParamAccess()

getModelRef

public ModelReference getModelRef()

isHidden

public java.lang.Boolean isHidden()

getPattern

public java.lang.String getPattern()

getVendorExtentions

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

getCollectionFormat

public java.lang.String getCollectionFormat()

isAllowEmptyValue

public java.lang.Boolean isAllowEmptyValue()

getScalarExample

public java.lang.Object getScalarExample()

getExamples

public com.google.common.collect.Multimap<java.lang.String,Example> getExamples()

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object