io.swagger.models.parameters

Class BodyParameter

java.lang.Object

io.swagger.models.parameters.AbstractParameter

io.swagger.models.parameters.BodyParameter

All Implemented Interfaces:

Parameter

public class BodyParameter
extends AbstractParameter
implements Parameter

Field Summary

Fields inherited from class io.swagger.models.parameters.AbstractParameter

access, allowEmptyValue, description, in, name, pattern, readOnly, required

Constructor Summary

Constructors

Constructor and Description
BodyParameter()

Method Summary

Methods

Modifier and Type	Method and Description
void	addExample(String mediaType, String value)
BodyParameter	description(String description)
boolean	equals(Object obj)
BodyParameter	example(String mediaType, String value)
Map<String,String>	getExamples()
Model	getSchema()
int	hashCode()
BodyParameter	name(String name)
BodyParameter	schema(Model schema)
void	setExamples(Map<String,String> examples)
void	setSchema(Model schema)

Methods inherited from class io.swagger.models.parameters.AbstractParameter

getAccess, getAllowEmptyValue, getDescription, getIn, getName, getPattern, getRequired, getVendorExtensions, isReadOnly, setAccess, setAllowEmptyValue, setDescription, setIn, setName, setPattern, setReadOnly, setRequired, setVendorExtension, setVendorExtensions

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.swagger.models.parameters.Parameter

getAccess, getAllowEmptyValue, getDescription, getIn, getName, getPattern, getRequired, getVendorExtensions, isReadOnly, setAccess, setAllowEmptyValue, setDescription, setIn, setName, setPattern, setReadOnly, setRequired

Constructor Detail

BodyParameter

public BodyParameter()

Method Detail

schema

public BodyParameter schema(Model schema)

example

public BodyParameter example(String mediaType,
                    String value)

description

public BodyParameter description(String description)

name

public BodyParameter name(String name)

getSchema

public Model getSchema()

setSchema

public void setSchema(Model schema)

addExample

public void addExample(String mediaType,
              String value)

getExamples

public Map<String,String> getExamples()

setExamples

public void setExamples(Map<String,String> examples)

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractParameter

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractParameter