springfox.documentation.service

Class Parameter

java.lang.Object

springfox.documentation.service.Parameter

public class Parameter
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description

Parameter(java.lang.String name, java.lang.String description, java.lang.String defaultValue, boolean required, boolean allowMultiple, ModelReference modelRef, com.google.common.base.Optional<com.fasterxml.classmate.ResolvedType> type, AllowableValues allowableValues, java.lang.String paramType, java.lang.String paramAccess, boolean hidden, java.lang.String pattern, java.lang.String collectionFormat, java.util.List<VendorExtension> vendorExtensions)

Method Summary

Methods

Modifier and Type	Method and Description
AllowableValues	getAllowableValues()
java.lang.String	getCollectionFormat()
java.lang.String	getDefaultValue()
java.lang.String	getDescription()
ModelReference	getModelRef()
java.lang.String	getName()
java.lang.String	getParamAccess()
java.lang.String	getParamType()
java.lang.String	getPattern()
com.google.common.base.Optional<com.fasterxml.classmate.ResolvedType>	getType()
java.util.List<VendorExtension>	getVendorExtentions()
java.lang.Boolean	isAllowMultiple()
java.lang.Boolean	isHidden()
java.lang.Boolean	isRequired()

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

public Parameter(java.lang.String name,
         java.lang.String description,
         java.lang.String defaultValue,
         boolean required,
         boolean allowMultiple,
         ModelReference modelRef,
         com.google.common.base.Optional<com.fasterxml.classmate.ResolvedType> type,
         AllowableValues allowableValues,
         java.lang.String paramType,
         java.lang.String paramAccess,
         boolean hidden,
         java.lang.String pattern,
         java.lang.String collectionFormat,
         java.util.List<VendorExtension> vendorExtensions)

Method Detail

getType

public com.google.common.base.Optional<com.fasterxml.classmate.ResolvedType> getType()

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getDefaultValue

public java.lang.String getDefaultValue()

isRequired

public java.lang.Boolean isRequired()

isAllowMultiple

public java.lang.Boolean isAllowMultiple()

getAllowableValues

public AllowableValues getAllowableValues()

getParamType

public java.lang.String getParamType()

getParamAccess

public java.lang.String getParamAccess()

getModelRef

public ModelReference getModelRef()

isHidden

public java.lang.Boolean isHidden()

getPattern

public java.lang.String getPattern()

getVendorExtentions

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

getCollectionFormat

public java.lang.String getCollectionFormat()