程序包 springfox.documentation.builders

类 ModelPropertyBuilder

java.lang.Object

springfox.documentation.builders.ModelPropertyBuilder

public class ModelPropertyBuilder
extends Object

构造器概要

构造器

构造器	说明
ModelPropertyBuilder()

方法概要

修饰符和类型	方法	说明
ModelPropertyBuilder	allowableValues(AllowableValues allowableValues)
ModelPropertyBuilder	allowEmptyValue(Boolean allowEmptyValue)	Support for isAllowEmpty value
ModelProperty	build()
ModelPropertyBuilder	defaultValue(String defaultValue)
ModelPropertyBuilder	description(String description)
ModelPropertyBuilder	example(Object example)	Updates the example
ModelPropertyBuilder	example(String example)	已过时。
ModelPropertyBuilder	extensions(List<VendorExtension> extensions)
ModelPropertyBuilder	isHidden(Boolean isHidden)
ModelPropertyBuilder	name(String name)
ModelPropertyBuilder	pattern(String pattern)
ModelPropertyBuilder	position(int position)
ModelPropertyBuilder	qualifiedType(String qualifiedType)
ModelPropertyBuilder	readOnly(Boolean readOnly)
ModelPropertyBuilder	required(Boolean required)
ModelPropertyBuilder	type(com.fasterxml.classmate.ResolvedType type)
ModelPropertyBuilder	xml(Xml xml)

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

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

构造器详细资料

ModelPropertyBuilder

public ModelPropertyBuilder()

方法详细资料

name

public ModelPropertyBuilder name(String name)

type

public ModelPropertyBuilder type(com.fasterxml.classmate.ResolvedType type)

qualifiedType

public ModelPropertyBuilder qualifiedType(String qualifiedType)

position

public ModelPropertyBuilder position(int position)

required

public ModelPropertyBuilder required(Boolean required)

readOnly

public ModelPropertyBuilder readOnly(Boolean readOnly)

description

public ModelPropertyBuilder description(String description)

example

@Deprecated
public ModelPropertyBuilder example(String example)

已过时。

Updates the example

参数:

example - - example value

返回:

this

从以下版本开始:

2.8.1 Use the one with Object as parameter

example

public ModelPropertyBuilder example(Object example)

Updates the example

参数:

example - - example value

返回:

this

从以下版本开始:

2.8.1

allowableValues

public ModelPropertyBuilder allowableValues(AllowableValues allowableValues)

isHidden

public ModelPropertyBuilder isHidden(Boolean isHidden)

pattern

public ModelPropertyBuilder pattern(String pattern)

extensions

public ModelPropertyBuilder extensions(List<VendorExtension> extensions)

defaultValue

public ModelPropertyBuilder defaultValue(String defaultValue)

allowEmptyValue

public ModelPropertyBuilder allowEmptyValue(Boolean allowEmptyValue)

Support for isAllowEmpty value

参数:

allowEmptyValue - true or false

返回:

true if supported

从以下版本开始:

2.8.0

xml

public ModelPropertyBuilder xml(Xml xml)

build

public ModelProperty build()