springfox.documentation.service

类 Parameter

java.lang.Object

springfox.documentation.service.Parameter

所有已实现的接口:

org.springframework.core.Ordered

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

字段概要

字段

限定符和类型	字段和说明
static int	DEFAULT_PRECEDENCE

从接口继承的字段 org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

构造器概要

构造器

构造器和说明

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

方法概要

限定符和类型	方法和说明
AllowableValues	getAllowableValues()
String	getCollectionFormat()
String	getDefaultValue()
String	getDescription()
com.google.common.collect.Multimap<String,Example>	getExamples()
ModelReference	getModelRef()
String	getName()
int	getOrder()
String	getParamAccess()
String	getParamType()
String	getPattern()
Object	getScalarExample()
com.google.common.base.Optional<com.fasterxml.classmate.ResolvedType>	getType()
List<VendorExtension>	getVendorExtentions()
Boolean	isAllowEmptyValue()
Boolean	isAllowMultiple()
Boolean	isHidden()
Boolean	isRequired()
String	toString()

从类继承的方法 java.lang.Object

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

字段详细资料

DEFAULT_PRECEDENCE

public static final int DEFAULT_PRECEDENCE

另请参阅:

常量字段值

构造器详细资料

Parameter

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

方法详细资料

getType

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

getName

public String getName()

getDescription

public String getDescription()

getDefaultValue

public String getDefaultValue()

isRequired

public Boolean isRequired()

isAllowMultiple

public Boolean isAllowMultiple()

getAllowableValues

public AllowableValues getAllowableValues()

getParamType

public String getParamType()

getParamAccess

public String getParamAccess()

getModelRef

public ModelReference getModelRef()

isHidden

public Boolean isHidden()

getPattern

public String getPattern()

getVendorExtentions

public List<VendorExtension> getVendorExtentions()

getCollectionFormat

public String getCollectionFormat()

isAllowEmptyValue

public Boolean isAllowEmptyValue()

getScalarExample

public Object getScalarExample()

getExamples

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

getOrder

public int getOrder()

指定者:

getOrder 在接口中 org.springframework.core.Ordered

toString

public String toString()

覆盖:

toString 在类中 Object