Package fish.payara.microprofile.openapi.impl.model

Class OperationImpl

java.lang.Object

fish.payara.microprofile.openapi.impl.model.ExtensibleImpl<org.eclipse.microprofile.openapi.models.Operation>

fish.payara.microprofile.openapi.impl.model.OperationImpl

All Implemented Interfaces:

org.eclipse.microprofile.openapi.models.Constructible, org.eclipse.microprofile.openapi.models.Extensible<org.eclipse.microprofile.openapi.models.Operation>, org.eclipse.microprofile.openapi.models.Operation

public class OperationImpl
extends ExtensibleImpl<org.eclipse.microprofile.openapi.models.Operation>
implements org.eclipse.microprofile.openapi.models.Operation

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback>	callbacks
protected Boolean	deprecated
protected String	description
protected List<String>	exceptionTypes
protected org.eclipse.microprofile.openapi.models.ExternalDocumentation	externalDocs
protected String	method
protected String	operationId
protected List<org.eclipse.microprofile.openapi.models.parameters.Parameter>	parameters
protected org.eclipse.microprofile.openapi.models.parameters.RequestBody	requestBody
protected org.eclipse.microprofile.openapi.models.responses.APIResponses	responses
protected List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement>	security
protected List<org.eclipse.microprofile.openapi.models.servers.Server>	servers
protected String	summary
protected List<String>	tags

Fields inherited from class fish.payara.microprofile.openapi.impl.model.ExtensibleImpl

extensions

Constructor Summary

Constructors

Constructor	Description
OperationImpl()

Method Summary

Modifier and Type	Method	Description
org.eclipse.microprofile.openapi.models.Operation	addCallback(String key, org.eclipse.microprofile.openapi.models.callbacks.Callback callback)
void	addExceptionType(String type)
org.eclipse.microprofile.openapi.models.Operation	addParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)
org.eclipse.microprofile.openapi.models.Operation	addSecurityRequirement(org.eclipse.microprofile.openapi.models.security.SecurityRequirement securityReq)
org.eclipse.microprofile.openapi.models.Operation	addServer(org.eclipse.microprofile.openapi.models.servers.Server server)
org.eclipse.microprofile.openapi.models.Operation	addTag(String tag)
static org.eclipse.microprofile.openapi.models.Operation	createInstance(org.glassfish.hk2.classmodel.reflect.AnnotationModel annotation, ApiContext context)
org.eclipse.microprofile.openapi.models.Operation	deprecated(Boolean deprecated)
Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback>	getCallbacks()
Boolean	getDeprecated()
String	getDescription()
List<String>	getExceptionTypes()
org.eclipse.microprofile.openapi.models.ExternalDocumentation	getExternalDocs()
String	getMethod()
String	getOperationId()
List<org.eclipse.microprofile.openapi.models.parameters.Parameter>	getParameters()
org.eclipse.microprofile.openapi.models.parameters.RequestBody	getRequestBody()
org.eclipse.microprofile.openapi.models.responses.APIResponses	getResponses()
List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement>	getSecurity()
List<org.eclipse.microprofile.openapi.models.servers.Server>	getServers()
String	getSummary()
List<String>	getTags()
static void	merge(org.eclipse.microprofile.openapi.models.Operation from, org.eclipse.microprofile.openapi.models.Operation to, boolean override)
static void	merge(org.eclipse.microprofile.openapi.models.Operation from, org.eclipse.microprofile.openapi.models.Operation to, boolean override, ApiContext context)
void	removeCallback(String key)
void	removeParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)
void	removeSecurityRequirement(org.eclipse.microprofile.openapi.models.security.SecurityRequirement securityRequirement)
void	removeServer(org.eclipse.microprofile.openapi.models.servers.Server server)
void	removeTag(String tag)
void	setCallbacks(Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback> callbacks)
void	setDeprecated(Boolean deprecated)
void	setDescription(String description)
void	setExternalDocs(org.eclipse.microprofile.openapi.models.ExternalDocumentation externalDocs)
void	setMethod(String method)
void	setOperationId(String operationId)
void	setParameters(List<org.eclipse.microprofile.openapi.models.parameters.Parameter> parameters)
void	setRequestBody(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody)
void	setResponses(org.eclipse.microprofile.openapi.models.responses.APIResponses responses)
void	setSecurity(List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> security)
void	setServers(List<org.eclipse.microprofile.openapi.models.servers.Server> servers)
void	setSummary(String summary)
void	setTags(List<String> tags)

Methods inherited from class fish.payara.microprofile.openapi.impl.model.ExtensibleImpl

addExtension, convertExtensionValue, extensionName, getExtensions, merge, removeExtension, setExtensions, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible

addExtension, extensions, getExtensions, removeExtension, setExtensions

Methods inherited from interface org.eclipse.microprofile.openapi.models.Operation

callbacks, description, externalDocs, operationId, parameters, requestBody, responses, security, servers, summary, tags

Field Detail

tags

protected List<String> tags

summary

protected String summary

description

protected String description

externalDocs

protected org.eclipse.microprofile.openapi.models.ExternalDocumentation externalDocs

operationId

protected String operationId

parameters

protected List<org.eclipse.microprofile.openapi.models.parameters.Parameter> parameters

requestBody

protected org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody

responses

protected org.eclipse.microprofile.openapi.models.responses.APIResponses responses

callbacks

protected Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback> callbacks

deprecated

protected Boolean deprecated

security

protected List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> security

servers

protected List<org.eclipse.microprofile.openapi.models.servers.Server> servers

method

protected String method

exceptionTypes

protected List<String> exceptionTypes

Constructor Detail

OperationImpl

public OperationImpl()

Method Detail

createInstance

public static org.eclipse.microprofile.openapi.models.Operation createInstance(org.glassfish.hk2.classmodel.reflect.AnnotationModel annotation,
                                                                               ApiContext context)

getTags

public List<String> getTags()

Specified by:

getTags in interface org.eclipse.microprofile.openapi.models.Operation

setTags

public void setTags(List<String> tags)

Specified by:

setTags in interface org.eclipse.microprofile.openapi.models.Operation

addTag

public org.eclipse.microprofile.openapi.models.Operation addTag(String tag)

Specified by:

addTag in interface org.eclipse.microprofile.openapi.models.Operation

removeTag

public void removeTag(String tag)

Specified by:

removeTag in interface org.eclipse.microprofile.openapi.models.Operation

getSummary

public String getSummary()

Specified by:

getSummary in interface org.eclipse.microprofile.openapi.models.Operation

setSummary

public void setSummary(String summary)

Specified by:

setSummary in interface org.eclipse.microprofile.openapi.models.Operation

getDescription

public String getDescription()

Specified by:

getDescription in interface org.eclipse.microprofile.openapi.models.Operation

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface org.eclipse.microprofile.openapi.models.Operation

getExternalDocs

public org.eclipse.microprofile.openapi.models.ExternalDocumentation getExternalDocs()

Specified by:

getExternalDocs in interface org.eclipse.microprofile.openapi.models.Operation

setExternalDocs

public void setExternalDocs(org.eclipse.microprofile.openapi.models.ExternalDocumentation externalDocs)

Specified by:

setExternalDocs in interface org.eclipse.microprofile.openapi.models.Operation

getOperationId

public String getOperationId()

Specified by:

getOperationId in interface org.eclipse.microprofile.openapi.models.Operation

setOperationId

public void setOperationId(String operationId)

Specified by:

setOperationId in interface org.eclipse.microprofile.openapi.models.Operation

getParameters

public List<org.eclipse.microprofile.openapi.models.parameters.Parameter> getParameters()

Specified by:

getParameters in interface org.eclipse.microprofile.openapi.models.Operation

setParameters

public void setParameters(List<org.eclipse.microprofile.openapi.models.parameters.Parameter> parameters)

Specified by:

setParameters in interface org.eclipse.microprofile.openapi.models.Operation

addParameter

public org.eclipse.microprofile.openapi.models.Operation addParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)

Specified by:

addParameter in interface org.eclipse.microprofile.openapi.models.Operation

removeParameter

public void removeParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)

Specified by:

removeParameter in interface org.eclipse.microprofile.openapi.models.Operation

getRequestBody

public org.eclipse.microprofile.openapi.models.parameters.RequestBody getRequestBody()

Specified by:

getRequestBody in interface org.eclipse.microprofile.openapi.models.Operation

setRequestBody

public void setRequestBody(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody)

Specified by:

setRequestBody in interface org.eclipse.microprofile.openapi.models.Operation

getResponses

public org.eclipse.microprofile.openapi.models.responses.APIResponses getResponses()

Specified by:

getResponses in interface org.eclipse.microprofile.openapi.models.Operation

setResponses

public void setResponses(org.eclipse.microprofile.openapi.models.responses.APIResponses responses)

Specified by:

setResponses in interface org.eclipse.microprofile.openapi.models.Operation

getCallbacks

public Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback> getCallbacks()

Specified by:

getCallbacks in interface org.eclipse.microprofile.openapi.models.Operation

setCallbacks

public void setCallbacks(Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback> callbacks)

Specified by:

setCallbacks in interface org.eclipse.microprofile.openapi.models.Operation

addCallback

public org.eclipse.microprofile.openapi.models.Operation addCallback(String key,
                                                                     org.eclipse.microprofile.openapi.models.callbacks.Callback callback)

Specified by:

addCallback in interface org.eclipse.microprofile.openapi.models.Operation

removeCallback

public void removeCallback(String key)

Specified by:

removeCallback in interface org.eclipse.microprofile.openapi.models.Operation

getDeprecated

public Boolean getDeprecated()

Specified by:

getDeprecated in interface org.eclipse.microprofile.openapi.models.Operation

setDeprecated

public void setDeprecated(Boolean deprecated)

Specified by:

setDeprecated in interface org.eclipse.microprofile.openapi.models.Operation

deprecated

public org.eclipse.microprofile.openapi.models.Operation deprecated(Boolean deprecated)

Specified by:

deprecated in interface org.eclipse.microprofile.openapi.models.Operation

getSecurity

public List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> getSecurity()

Specified by:

getSecurity in interface org.eclipse.microprofile.openapi.models.Operation

setSecurity

public void setSecurity(List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> security)

Specified by:

setSecurity in interface org.eclipse.microprofile.openapi.models.Operation

addSecurityRequirement

public org.eclipse.microprofile.openapi.models.Operation addSecurityRequirement(org.eclipse.microprofile.openapi.models.security.SecurityRequirement securityReq)

Specified by:

addSecurityRequirement in interface org.eclipse.microprofile.openapi.models.Operation

removeSecurityRequirement

public void removeSecurityRequirement(org.eclipse.microprofile.openapi.models.security.SecurityRequirement securityRequirement)

Specified by:

removeSecurityRequirement in interface org.eclipse.microprofile.openapi.models.Operation

getServers

public List<org.eclipse.microprofile.openapi.models.servers.Server> getServers()

Specified by:

getServers in interface org.eclipse.microprofile.openapi.models.Operation

setServers

public void setServers(List<org.eclipse.microprofile.openapi.models.servers.Server> servers)

Specified by:

setServers in interface org.eclipse.microprofile.openapi.models.Operation

addServer

public org.eclipse.microprofile.openapi.models.Operation addServer(org.eclipse.microprofile.openapi.models.servers.Server server)

Specified by:

addServer in interface org.eclipse.microprofile.openapi.models.Operation

removeServer

public void removeServer(org.eclipse.microprofile.openapi.models.servers.Server server)

Specified by:

removeServer in interface org.eclipse.microprofile.openapi.models.Operation

getMethod

public String getMethod()

setMethod

public void setMethod(String method)

getExceptionTypes

public List<String> getExceptionTypes()

addExceptionType

public void addExceptionType(String type)

merge

public static void merge(org.eclipse.microprofile.openapi.models.Operation from,
                         org.eclipse.microprofile.openapi.models.Operation to,
                         boolean override)

merge

public static void merge(org.eclipse.microprofile.openapi.models.Operation from,
                         org.eclipse.microprofile.openapi.models.Operation to,
                         boolean override,
                         ApiContext context)