Package springfox.documentation.builders

Class PropertySpecificationBuilder

java.lang.Object

springfox.documentation.builders.PropertySpecificationBuilder

public class PropertySpecificationBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
PropertySpecificationBuilder(java.lang.String name)

Method Summary

Modifier and Type	Method	Description
PropertySpecificationBuilder	allowEmptyValue(java.lang.Boolean allowEmptyValue)
PropertySpecification	build()
PropertySpecificationBuilder	collectionFacet(java.util.function.Consumer<CollectionElementFacetBuilder> facet)
PropertySpecificationBuilder	defaultValue(java.lang.Object defaultValue)
PropertySpecificationBuilder	deprecated(java.lang.Boolean deprecated)
PropertySpecificationBuilder	description(java.lang.String description)
PropertySpecificationBuilder	enumerationFacet(java.util.function.Consumer<EnumerationElementFacetBuilder> facet)
PropertySpecificationBuilder	example(java.lang.Object example)
<T extends ElementFacetBuilder> T	facetBuilder(java.lang.Class<T> clazz)
PropertySpecificationBuilder	isHidden(java.lang.Boolean isHidden)
PropertySpecificationBuilder	nullable(java.lang.Boolean nullable)
PropertySpecificationBuilder	numericFacet(java.util.function.Consumer<NumericElementFacetBuilder> facet)
PropertySpecificationBuilder	position(int position)
PropertySpecificationBuilder	readOnly(java.lang.Boolean readOnly)
PropertySpecificationBuilder	required(java.lang.Boolean required)
PropertySpecificationBuilder	stringFacet(java.util.function.Consumer<StringElementFacetBuilder> facet)
PropertySpecificationBuilder	type(ModelSpecification type)
PropertySpecificationBuilder	vendorExtensions(java.util.List<VendorExtension> vendorExtensions)
PropertySpecificationBuilder	writeOnly(java.lang.Boolean writeOnly)
PropertySpecificationBuilder	xml(Xml xml)

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertySpecificationBuilder

public PropertySpecificationBuilder(java.lang.String name)

Method Detail

description

public PropertySpecificationBuilder description(java.lang.String description)

type

public PropertySpecificationBuilder type(ModelSpecification type)

facetBuilder

public <T extends ElementFacetBuilder> T facetBuilder(java.lang.Class<T> clazz)

collectionFacet

public PropertySpecificationBuilder collectionFacet(@NonNull
                                                    java.util.function.Consumer<CollectionElementFacetBuilder> facet)

stringFacet

public PropertySpecificationBuilder stringFacet(@NonNull
                                                java.util.function.Consumer<StringElementFacetBuilder> facet)

numericFacet

public PropertySpecificationBuilder numericFacet(@NonNull
                                                 java.util.function.Consumer<NumericElementFacetBuilder> facet)

enumerationFacet

public PropertySpecificationBuilder enumerationFacet(@NonNull
                                                     java.util.function.Consumer<EnumerationElementFacetBuilder> facet)

nullable

public PropertySpecificationBuilder nullable(java.lang.Boolean nullable)

required

public PropertySpecificationBuilder required(java.lang.Boolean required)

readOnly

public PropertySpecificationBuilder readOnly(java.lang.Boolean readOnly)

writeOnly

public PropertySpecificationBuilder writeOnly(java.lang.Boolean writeOnly)

deprecated

public PropertySpecificationBuilder deprecated(java.lang.Boolean deprecated)

allowEmptyValue

public PropertySpecificationBuilder allowEmptyValue(java.lang.Boolean allowEmptyValue)

isHidden

public PropertySpecificationBuilder isHidden(java.lang.Boolean isHidden)

position

public PropertySpecificationBuilder position(int position)

example

public PropertySpecificationBuilder example(java.lang.Object example)

defaultValue

public PropertySpecificationBuilder defaultValue(java.lang.Object defaultValue)

xml

public PropertySpecificationBuilder xml(Xml xml)

vendorExtensions

public PropertySpecificationBuilder vendorExtensions(java.util.List<VendorExtension> vendorExtensions)

build

public PropertySpecification build()