Package de.fraunhofer.iosb.ilt.frostserver.plugin.openapi.spec

Class OAParameter

java.lang.Object

de.fraunhofer.iosb.ilt.frostserver.plugin.openapi.spec.OAParameter

public final class OAParameter
extends Object

An OpenAPI parameter object.

Author:

scf

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OAParameter.In

Constructor Summary

Constructors

Constructor	Description
OAParameter(String refName)
OAParameter(String name, OAParameter.In in, String description, OASchema schema)
OAParameter(String name, String description, OASchema schema)

Method Summary

Modifier and Type	Method	Description
String	getDescription()
OAParameter.In	getIn()
String	getName()
String	getRef()
Boolean	getRequired()
OASchema	getSchema()
void	setDescription(String description)
void	setIn(OAParameter.In in)
void	setName(String name)
void	setRef(String ref)
void	setRequired(Boolean required)
void	setSchema(OASchema schema)

Methods inherited from class java.lang.Object

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

Constructor Details

OAParameter

public OAParameter(String refName)

OAParameter

public OAParameter(String name,
 String description,
 OASchema schema)

OAParameter

public OAParameter(String name,
 OAParameter.In in,
 String description,
 OASchema schema)

Method Details

getRef

public String getRef()

Returns:

the ref

setRef

public void setRef(String ref)

Parameters:

ref - the ref to set

getName

public String getName()

Returns:

the name

setName

public void setName(String name)

Parameters:

name - the name to set

getIn

public OAParameter.In getIn()

Returns:

the in

setIn

public void setIn(OAParameter.In in)

Parameters:

in - the in to set

getDescription

public String getDescription()

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - the description to set

getRequired

public Boolean getRequired()

Returns:

the required

setRequired

public void setRequired(Boolean required)

Parameters:

required - the required to set

getSchema

public OASchema getSchema()

Returns:

the schema

setSchema

public void setSchema(OASchema schema)

Parameters:

schema - the schema to set