springfox.documentation.schema

Class ModelProperty

java.lang.Object

springfox.documentation.schema.ModelProperty

public class ModelProperty
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description

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

Method Summary

Modifier and Type	Method and Description
AllowableValues	getAllowableValues()
java.lang.String	getDefaultValue()
java.lang.String	getDescription()
java.lang.Object	getExample()
ModelReference	getModelRef()
java.lang.String	getName()
java.lang.String	getPattern()
int	getPosition()
java.lang.String	getQualifiedType()
com.fasterxml.classmate.ResolvedType	getType()
java.util.List<VendorExtension>	getVendorExtensions()
Xml	getXml()
java.lang.Boolean	isAllowEmptyValue() Support for isAllowEmpty value
boolean	isHidden()
java.lang.Boolean	isReadOnly()
java.lang.Boolean	isRequired()
ModelProperty	updateModelRef(com.google.common.base.Function<com.fasterxml.classmate.ResolvedType,? extends ModelReference> modelRefFactory)

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelProperty

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

Method Detail

getName

public java.lang.String getName()

getType

public com.fasterxml.classmate.ResolvedType getType()

getQualifiedType

public java.lang.String getQualifiedType()

getPosition

public int getPosition()

isRequired

public java.lang.Boolean isRequired()

isReadOnly

public java.lang.Boolean isReadOnly()

getDescription

public java.lang.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 java.lang.Object getExample()

getPattern

public java.lang.String getPattern()

getVendorExtensions

public java.util.List<VendorExtension> getVendorExtensions()

getDefaultValue

public java.lang.String getDefaultValue()

getXml

public Xml getXml()

isAllowEmptyValue

public java.lang.Boolean isAllowEmptyValue()

Support for isAllowEmpty value

Returns:

true if supported

Since:

2.8.0