springfox.documentation.schema

类 ModelProperty

java.lang.Object

springfox.documentation.schema.ModelProperty

public class ModelProperty
extends Object

构造器概要

构造器

构造器和说明
ModelProperty(String name, com.fasterxml.classmate.ResolvedType type, String qualifiedType, int position, boolean required, boolean isHidden, boolean readOnly, Boolean allowEmptyValue, String description, AllowableValues allowableValues, Object example, String pattern, String defaultValue, Xml xml, List<VendorExtension> vendorExtensions)

方法概要

限定符和类型	方法和说明
AllowableValues	getAllowableValues()
String	getDefaultValue()
String	getDescription()
Object	getExample()
ModelReference	getModelRef()
String	getName()
String	getPattern()
int	getPosition()
String	getQualifiedType()
com.fasterxml.classmate.ResolvedType	getType()
List<VendorExtension>	getVendorExtensions()
Xml	getXml()
Boolean	isAllowEmptyValue() Support for isAllowEmpty value
boolean	isHidden()
Boolean	isReadOnly()
Boolean	isRequired()
ModelProperty	updateModelRef(com.google.common.base.Function<com.fasterxml.classmate.ResolvedType,? extends ModelReference> modelRefFactory)

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

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

构造器详细资料

ModelProperty

public ModelProperty(String name,
                     com.fasterxml.classmate.ResolvedType type,
                     String qualifiedType,
                     int position,
                     boolean required,
                     boolean isHidden,
                     boolean readOnly,
                     Boolean allowEmptyValue,
                     String description,
                     AllowableValues allowableValues,
                     Object example,
                     String pattern,
                     String defaultValue,
                     Xml xml,
                     List<VendorExtension> vendorExtensions)

方法详细资料

getName

public String getName()

getType

public com.fasterxml.classmate.ResolvedType getType()

getQualifiedType

public String getQualifiedType()

getPosition

public int getPosition()

isRequired

public Boolean isRequired()

isReadOnly

public Boolean isReadOnly()

getDescription

public String getDescription()

getAllowableValues

public AllowableValues getAllowableValues()

getModelRef

public ModelReference getModelRef()

isHidden

public boolean isHidden()

updateModelRef

public ModelProperty updateModelRef(com.google.common.base.Function<com.fasterxml.classmate.ResolvedType,? extends ModelReference> modelRefFactory)

getExample

public Object getExample()

getPattern

public String getPattern()

getVendorExtensions

public List<VendorExtension> getVendorExtensions()

getDefaultValue

public String getDefaultValue()

getXml

public Xml getXml()

isAllowEmptyValue

public Boolean isAllowEmptyValue()

Support for isAllowEmpty value

返回:

true if supported

从以下版本开始:

2.8.0