Package 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	Description
ModelPropertyContext(ModelPropertyBuilder builder, com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition beanPropertyDefinition, com.fasterxml.classmate.TypeResolver resolver, ModelContext owner, PropertySpecificationBuilder specificationBuilder)
ModelPropertyContext(ModelPropertyBuilder builder, PropertySpecificationBuilder specificationBuilder, java.lang.reflect.AnnotatedElement annotatedElement, com.fasterxml.classmate.TypeResolver resolver, ModelContext owner)

Method Summary

Modifier and Type	Method	Description
java.util.Optional<java.lang.reflect.AnnotatedElement>	getAnnotatedElement()
java.util.Optional<com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition>	getBeanPropertyDefinition()
ModelPropertyBuilder	getBuilder()	Deprecated. Use getSpecificationBuilder() instead
DocumentationType	getDocumentationType()	Documentation type this context supports, swagger 1.2, 2.0 or vanilla spring mvc
ModelContext	getOwner()	Owning model context
com.fasterxml.classmate.TypeResolver	getResolver()
PropertySpecificationBuilder	getSpecificationBuilder()	Model property specification.

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,
                            PropertySpecificationBuilder specificationBuilder,
                            java.lang.reflect.AnnotatedElement annotatedElement,
                            com.fasterxml.classmate.TypeResolver resolver,
                            ModelContext owner)

ModelPropertyContext

public ModelPropertyContext(ModelPropertyBuilder builder,
                            com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition beanPropertyDefinition,
                            com.fasterxml.classmate.TypeResolver resolver,
                            ModelContext owner,
                            PropertySpecificationBuilder specificationBuilder)

Method Detail

getBuilder

@Deprecated
public ModelPropertyBuilder getBuilder()

Deprecated.

Use getSpecificationBuilder() instead

Model property build. Use this to override model property attributes

Returns:

the builder

Since:

3.0

getSpecificationBuilder

public PropertySpecificationBuilder getSpecificationBuilder()

Model property specification. 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 java.util.Optional<java.lang.reflect.AnnotatedElement> getAnnotatedElement()

Returns:

annotated element that this model property is annotated with

getBeanPropertyDefinition

public java.util.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

getOwner

public ModelContext getOwner()

Owning model context

Returns:

context that owns the property