Class BaseModelProperty
- java.lang.Object
-
- springfox.documentation.schema.property.BaseModelProperty
-
- All Implemented Interfaces:
ModelProperty
- Direct Known Subclasses:
BeanModelProperty
,FieldModelProperty
,ParameterModelProperty
public abstract class BaseModelProperty extends java.lang.Object implements ModelProperty
-
-
Constructor Summary
Constructors Constructor Description BaseModelProperty(java.lang.String name, com.fasterxml.classmate.TypeResolver resolver, springfox.documentation.spi.schema.AlternateTypeProvider alternateTypeProvider, com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition jacksonProperty)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description springfox.documentation.service.AllowableValues
allowableValues()
java.lang.String
example()
springfox.documentation.spi.schema.AlternateTypeProvider
getAlternateTypeProvider()
java.lang.String
getName()
com.fasterxml.classmate.TypeResolver
getResolver()
com.fasterxml.classmate.ResolvedType
getType()
boolean
isReadOnly()
boolean
isRequired()
int
position()
java.lang.String
propertyDescription()
java.lang.String
qualifiedTypeName()
protected abstract com.fasterxml.classmate.ResolvedType
realType()
-
-
-
Method Detail
-
realType
protected abstract com.fasterxml.classmate.ResolvedType realType()
-
getType
public com.fasterxml.classmate.ResolvedType getType()
- Specified by:
getType
in interfaceModelProperty
-
getName
public java.lang.String getName()
- Specified by:
getName
in interfaceModelProperty
-
qualifiedTypeName
public java.lang.String qualifiedTypeName()
- Specified by:
qualifiedTypeName
in interfaceModelProperty
-
allowableValues
public springfox.documentation.service.AllowableValues allowableValues()
- Specified by:
allowableValues
in interfaceModelProperty
-
isRequired
public boolean isRequired()
- Specified by:
isRequired
in interfaceModelProperty
-
isReadOnly
public boolean isReadOnly()
- Specified by:
isReadOnly
in interfaceModelProperty
-
propertyDescription
public java.lang.String propertyDescription()
- Specified by:
propertyDescription
in interfaceModelProperty
-
position
public int position()
- Specified by:
position
in interfaceModelProperty
-
getResolver
public com.fasterxml.classmate.TypeResolver getResolver()
-
getAlternateTypeProvider
public springfox.documentation.spi.schema.AlternateTypeProvider getAlternateTypeProvider()
-
example
public java.lang.String example()
-
-