springfox.documentation.builders

Class ModelPropertyBuilder

java.lang.Object

springfox.documentation.builders.ModelPropertyBuilder

public class ModelPropertyBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ModelPropertyBuilder()

Method Summary

Modifier and Type	Method and Description
ModelPropertyBuilder	allowableValues(AllowableValues allowableValues)
ModelPropertyBuilder	allowEmptyValue(java.lang.Boolean allowEmptyValue) Support for isAllowEmpty value
ModelProperty	build()
ModelPropertyBuilder	defaultValue(java.lang.String defaultValue)
ModelPropertyBuilder	description(java.lang.String description)
ModelPropertyBuilder	example(java.lang.Object example) Updates the example
ModelPropertyBuilder	example(java.lang.String example) Deprecated. @since 2.8.1 Use the one with Object as parameter
ModelPropertyBuilder	extensions(java.util.List<VendorExtension> extensions)
ModelPropertyBuilder	isHidden(java.lang.Boolean isHidden)
ModelPropertyBuilder	name(java.lang.String name)
ModelPropertyBuilder	pattern(java.lang.String pattern)
ModelPropertyBuilder	position(int position)
ModelPropertyBuilder	qualifiedType(java.lang.String qualifiedType)
ModelPropertyBuilder	readOnly(java.lang.Boolean readOnly)
ModelPropertyBuilder	required(java.lang.Boolean required)
ModelPropertyBuilder	type(com.fasterxml.classmate.ResolvedType type)
ModelPropertyBuilder	xml(Xml xml)

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelPropertyBuilder

public ModelPropertyBuilder()

Method Detail

name

public ModelPropertyBuilder name(java.lang.String name)

type

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

qualifiedType

public ModelPropertyBuilder qualifiedType(java.lang.String qualifiedType)

position

public ModelPropertyBuilder position(int position)

required

public ModelPropertyBuilder required(java.lang.Boolean required)

readOnly

public ModelPropertyBuilder readOnly(java.lang.Boolean readOnly)

description

public ModelPropertyBuilder description(java.lang.String description)

example

@Deprecated
public ModelPropertyBuilder example(java.lang.String example)

Deprecated. @since 2.8.1 Use the one with Object as parameter

Updates the example

Parameters:

example - - example value

Returns:

this

example

public ModelPropertyBuilder example(java.lang.Object example)

Updates the example

Parameters:

example - - example value

Returns:

this

Since:

2.8.1

allowableValues

public ModelPropertyBuilder allowableValues(AllowableValues allowableValues)

isHidden

public ModelPropertyBuilder isHidden(java.lang.Boolean isHidden)

pattern

public ModelPropertyBuilder pattern(java.lang.String pattern)

extensions

public ModelPropertyBuilder extensions(java.util.List<VendorExtension> extensions)

defaultValue

public ModelPropertyBuilder defaultValue(java.lang.String defaultValue)

allowEmptyValue

public ModelPropertyBuilder allowEmptyValue(java.lang.Boolean allowEmptyValue)

Support for isAllowEmpty value

Parameters:

allowEmptyValue - true or false

Returns:

true if supported

Since:

2.8.0

xml

public ModelPropertyBuilder xml(Xml xml)

build

public ModelProperty build()