Package springfox.documentation.schema

Class PropertySpecification

java.lang.Object

springfox.documentation.schema.PropertySpecification

All Implemented Interfaces:

ElementFacetSource

public class PropertySpecification
extends java.lang.Object
implements ElementFacetSource

Constructor Summary

Constructors

Constructor

Description

PropertySpecification(java.lang.String name, java.lang.String description, ModelSpecification type, java.util.List<ElementFacet> facets, java.lang.Boolean nullable, java.lang.Boolean required, java.lang.Boolean readOnly, java.lang.Boolean writeOnly, java.lang.Boolean deprecated, java.lang.Boolean allowEmptyValue, java.lang.Boolean isHidden, int position, java.lang.Object example, java.lang.Object defaultValue, Xml xml, java.util.List<VendorExtension> vendorExtensions)

Method Summary

Modifier and Type	Method	Description
<T extends ElementFacet> java.util.Optional<T>	elementFacet(java.lang.Class<T> clazz)
boolean	equals(java.lang.Object o)
java.lang.Boolean	getAllowEmptyValue()
java.lang.Object	getDefaultValue()
java.lang.Boolean	getDeprecated()
java.lang.String	getDescription()
java.lang.Object	getExample()
java.util.List<ElementFacet>	getFacets()
java.lang.Boolean	getHidden()
java.lang.String	getName()
java.lang.Boolean	getNullable()
int	getPosition()
java.lang.Boolean	getReadOnly()
java.lang.Boolean	getRequired()
ModelSpecification	getType()
java.util.List<VendorExtension>	getVendorExtensions()
java.lang.Boolean	getWriteOnly()
Xml	getXml()
int	hashCode()
java.lang.Boolean	nullSafeIsRequired()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PropertySpecification

public PropertySpecification(java.lang.String name,
                             java.lang.String description,
                             ModelSpecification type,
                             java.util.List<ElementFacet> facets,
                             java.lang.Boolean nullable,
                             java.lang.Boolean required,
                             java.lang.Boolean readOnly,
                             java.lang.Boolean writeOnly,
                             java.lang.Boolean deprecated,
                             java.lang.Boolean allowEmptyValue,
                             java.lang.Boolean isHidden,
                             int position,
                             java.lang.Object example,
                             java.lang.Object defaultValue,
                             Xml xml,
                             java.util.List<VendorExtension> vendorExtensions)

Method Detail

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getType

public ModelSpecification getType()

getFacets

public java.util.List<ElementFacet> getFacets()

elementFacet

public <T extends ElementFacet> java.util.Optional<T> elementFacet(java.lang.Class<T> clazz)

Specified by:

elementFacet in interface ElementFacetSource

getNullable

public java.lang.Boolean getNullable()

getRequired

public java.lang.Boolean getRequired()

nullSafeIsRequired

public java.lang.Boolean nullSafeIsRequired()

getReadOnly

public java.lang.Boolean getReadOnly()

getWriteOnly

public java.lang.Boolean getWriteOnly()

getDeprecated

public java.lang.Boolean getDeprecated()

getAllowEmptyValue

public java.lang.Boolean getAllowEmptyValue()

getHidden

public java.lang.Boolean getHidden()

getPosition

public int getPosition()

getExample

public java.lang.Object getExample()

getDefaultValue

public java.lang.Object getDefaultValue()

getXml

public Xml getXml()

getVendorExtensions

public java.util.List<VendorExtension> getVendorExtensions()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object