springfox.documentation.builders

Class ModelBuilder

java.lang.Object

springfox.documentation.builders.ModelBuilder

public class ModelBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ModelBuilder()

Method Summary

Modifier and Type	Method and Description
ModelBuilder	baseModel(java.lang.String baseModel) Update the based model
Model	build()
ModelBuilder	description(java.lang.String description) Update the description of the model
ModelBuilder	discriminator(java.lang.String discriminator) Updates inheritance discriminator, used to identify inherited subclasses.
ModelBuilder	example(java.lang.Object example) Updates the Example for the model
ModelBuilder	example(java.lang.String example) Deprecated. @since 2.8.1 Use the one which takes in an Object instead
ModelBuilder	id(java.lang.String id) Updates the Id of the model, usually the type name
ModelBuilder	name(java.lang.String name) Updates the Name of the model
ModelBuilder	properties(java.util.Map<java.lang.String,ModelProperty> properties) Updates the model properties
ModelBuilder	qualifiedType(java.lang.String qualifiedType) Fully package qualified name of the model
ModelBuilder	subTypes(java.util.List<ModelReference> subTypes) Updates the subclasses for this model.
ModelBuilder	type(com.fasterxml.classmate.ResolvedType modelType) Represents the type information with full fidelity of generics
ModelBuilder	xml(Xml xml)

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelBuilder

public ModelBuilder()

Method Detail

id

public ModelBuilder id(java.lang.String id)

Updates the Id of the model, usually the type name

Parameters:

id - - identifier for the model

Returns:

this

name

public ModelBuilder name(java.lang.String name)

Updates the Name of the model

Parameters:

name - - name of the model

Returns:

this

qualifiedType

public ModelBuilder qualifiedType(java.lang.String qualifiedType)

Fully package qualified name of the model

Parameters:

qualifiedType - - package qualified name

Returns:

this

properties

public ModelBuilder properties(java.util.Map<java.lang.String,ModelProperty> properties)

Updates the model properties

Parameters:

properties - - map of properties by name

Returns:

this

description

public ModelBuilder description(java.lang.String description)

Update the description of the model

Parameters:

description - - description

Returns:

this

baseModel

public ModelBuilder baseModel(java.lang.String baseModel)

Update the based model

Parameters:

baseModel - - based model as in inherited parent model. We currently don't implement this feature

Returns:

this

discriminator

public ModelBuilder discriminator(java.lang.String discriminator)

Updates inheritance discriminator, used to identify inherited subclasses. We currently don't implement this feature

Parameters:

discriminator - - inheritance discriminator

Returns:

this

subTypes

public ModelBuilder subTypes(java.util.List<ModelReference> subTypes)

Updates the subclasses for this model.

Parameters:

subTypes - - Models inheriting from this model

Returns:

this

Since:

2.8.1 We changed the subType to be a model refers

example

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

Deprecated. @since 2.8.1 Use the one which takes in an Object instead

Updates the Example for the model

Parameters:

example - - example of the model

Returns:

this

example

public ModelBuilder example(java.lang.Object example)

Updates the Example for the model

Parameters:

example - - example of the model

Returns:

this

Since:

2.8.1

type

public ModelBuilder type(com.fasterxml.classmate.ResolvedType modelType)

Represents the type information with full fidelity of generics

Parameters:

modelType - - resolved type that represents the model

Returns:

this

xml

public ModelBuilder xml(Xml xml)

build

public Model build()