springfox.documentation.schema

Class ModelRef

java.lang.Object

springfox.documentation.schema.ModelRef

All Implemented Interfaces:

ModelReference

public class ModelRef
extends java.lang.Object
implements ModelReference

Constructor Summary

Constructors

Constructor and Description
ModelRef(java.lang.String type)
ModelRef(java.lang.String type, AllowableValues allowableValues)
ModelRef(java.lang.String type, ModelReference itemType)
ModelRef(java.lang.String type, ModelReference itemType, AllowableValues allowableValues)
ModelRef(java.lang.String type, ModelReference itemModel, AllowableValues allowableValues, boolean isMap)
ModelRef(java.lang.String type, ModelReference itemType, boolean isMap)

Method Summary

Modifier and Type	Method and Description
AllowableValues	getAllowableValues()
java.lang.String	getItemType()
java.lang.String	getType()
boolean	isCollection()
boolean	isMap()
com.google.common.base.Optional<ModelReference>	itemModel()

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelRef

public ModelRef(java.lang.String type)

ModelRef

public ModelRef(java.lang.String type,
                ModelReference itemType)

ModelRef

public ModelRef(java.lang.String type,
                ModelReference itemType,
                AllowableValues allowableValues)

ModelRef

public ModelRef(java.lang.String type,
                AllowableValues allowableValues)

ModelRef

public ModelRef(java.lang.String type,
                ModelReference itemType,
                boolean isMap)

ModelRef

public ModelRef(java.lang.String type,
                ModelReference itemModel,
                AllowableValues allowableValues,
                boolean isMap)

Method Detail

getType

public java.lang.String getType()

Specified by:

getType in interface ModelReference

isCollection

public boolean isCollection()

Specified by:

isCollection in interface ModelReference

isMap

public boolean isMap()

Specified by:

isMap in interface ModelReference

getItemType

public java.lang.String getItemType()

Specified by:

getItemType in interface ModelReference

getAllowableValues

public AllowableValues getAllowableValues()

Specified by:

getAllowableValues in interface ModelReference

itemModel

public com.google.common.base.Optional<ModelReference> itemModel()

Specified by:

itemModel in interface ModelReference