springfox.documentation.schema.property

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

Field Summary

Fields

Modifier and Type	Field and Description
protected springfox.documentation.spi.schema.AlternateTypeProvider	alternateTypeProvider
protected com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition	jacksonProperty
protected com.google.common.base.Optional<com.fasterxml.jackson.annotation.JsonFormat>	jsonFormatAnnotation
protected com.fasterxml.classmate.TypeResolver	resolver

Constructor Summary

Constructors

Constructor and 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

Modifier and Type	Method and Description
springfox.documentation.service.AllowableValues	allowableValues()
java.lang.String	example()
java.lang.String	getName()
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()

Methods inherited from class java.lang.Object

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

Field Detail

jacksonProperty

protected final com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition jacksonProperty

jsonFormatAnnotation

protected final com.google.common.base.Optional<com.fasterxml.jackson.annotation.JsonFormat> jsonFormatAnnotation

resolver

protected final com.fasterxml.classmate.TypeResolver resolver

alternateTypeProvider

protected final springfox.documentation.spi.schema.AlternateTypeProvider alternateTypeProvider

Constructor Detail

BaseModelProperty

public BaseModelProperty(java.lang.String name,
                         com.fasterxml.classmate.TypeResolver resolver,
                         springfox.documentation.spi.schema.AlternateTypeProvider alternateTypeProvider,
                         com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition jacksonProperty)

Method Detail

realType

protected abstract com.fasterxml.classmate.ResolvedType realType()

getType

public com.fasterxml.classmate.ResolvedType getType()

Specified by:

getType in interface ModelProperty

getName

public java.lang.String getName()

Specified by:

getName in interface ModelProperty

qualifiedTypeName

public java.lang.String qualifiedTypeName()

Specified by:

qualifiedTypeName in interface ModelProperty

allowableValues

public springfox.documentation.service.AllowableValues allowableValues()

Specified by:

allowableValues in interface ModelProperty

isRequired

public boolean isRequired()

Specified by:

isRequired in interface ModelProperty

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface ModelProperty

propertyDescription

public java.lang.String propertyDescription()

Specified by:

propertyDescription in interface ModelProperty

position

public int position()

Specified by:

position in interface ModelProperty

example

public java.lang.String example()