springfox.documentation.spi.schema.contexts

Class ModelPropertyContext

java.lang.Object

springfox.documentation.spi.schema.contexts.ModelPropertyContext

public class ModelPropertyContext
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ModelPropertyContext(ModelPropertyBuilder builder, java.lang.reflect.AnnotatedElement annotatedElement, com.fasterxml.classmate.TypeResolver resolver, DocumentationType documentationType)
ModelPropertyContext(ModelPropertyBuilder builder, com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition beanPropertyDefinition, com.fasterxml.classmate.TypeResolver resolver, DocumentationType documentationType)

Method Summary

Modifier and Type	Method and Description
com.google.common.base.Optional<java.lang.reflect.AnnotatedElement>	getAnnotatedElement()
com.google.common.base.Optional<com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition>	getBeanPropertyDefinition()
ModelPropertyBuilder	getBuilder() Model property build.
DocumentationType	getDocumentationType() Documentation type this context supports, swagger 1.2, 2.0 or vanilla spring mvc
com.fasterxml.classmate.TypeResolver	getResolver()

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelPropertyContext

public ModelPropertyContext(ModelPropertyBuilder builder,
                            java.lang.reflect.AnnotatedElement annotatedElement,
                            com.fasterxml.classmate.TypeResolver resolver,
                            DocumentationType documentationType)

ModelPropertyContext

public ModelPropertyContext(ModelPropertyBuilder builder,
                            com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition beanPropertyDefinition,
                            com.fasterxml.classmate.TypeResolver resolver,
                            DocumentationType documentationType)

Method Detail

getBuilder

public ModelPropertyBuilder getBuilder()

Model property build. Use this to override model property attributes

Returns:

the builder

getDocumentationType

public DocumentationType getDocumentationType()

Documentation type this context supports, swagger 1.2, 2.0 or vanilla spring mvc

Returns:

documentation type

getAnnotatedElement

public com.google.common.base.Optional<java.lang.reflect.AnnotatedElement> getAnnotatedElement()

Returns:

annotated element that this model property is annotated with

getBeanPropertyDefinition

public com.google.common.base.Optional<com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition> getBeanPropertyDefinition()

Returns:

bean property definition for this model property

getResolver

public com.fasterxml.classmate.TypeResolver getResolver()

Returns:

resolver used to resolve types