io.smallrye.openapi.api.models

Class PathItemImpl

java.lang.Object

io.smallrye.openapi.api.models.ExtensibleImpl<org.eclipse.microprofile.openapi.models.PathItem>

io.smallrye.openapi.api.models.PathItemImpl

All Implemented Interfaces:

ModelImpl, org.eclipse.microprofile.openapi.models.Constructible, org.eclipse.microprofile.openapi.models.Extensible<org.eclipse.microprofile.openapi.models.PathItem>, org.eclipse.microprofile.openapi.models.PathItem, org.eclipse.microprofile.openapi.models.Reference<org.eclipse.microprofile.openapi.models.PathItem>

public class PathItemImpl
extends ExtensibleImpl<org.eclipse.microprofile.openapi.models.PathItem>
implements org.eclipse.microprofile.openapi.models.PathItem, ModelImpl

An implementation of the PathItem OpenAPI model interface.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.microprofile.openapi.models.PathItem

org.eclipse.microprofile.openapi.models.PathItem.HttpMethod

Constructor Summary

Constructors

Constructor and Description
PathItemImpl()

Method Summary

Modifier and Type	Method and Description
org.eclipse.microprofile.openapi.models.PathItem	addParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)
org.eclipse.microprofile.openapi.models.PathItem	addServer(org.eclipse.microprofile.openapi.models.servers.Server server)
org.eclipse.microprofile.openapi.models.Operation	getDELETE()
String	getDescription()
org.eclipse.microprofile.openapi.models.Operation	getGET()
org.eclipse.microprofile.openapi.models.Operation	getHEAD()
Map<org.eclipse.microprofile.openapi.models.PathItem.HttpMethod,org.eclipse.microprofile.openapi.models.Operation>	getOperations()
org.eclipse.microprofile.openapi.models.Operation	getOPTIONS()
List<org.eclipse.microprofile.openapi.models.parameters.Parameter>	getParameters()
org.eclipse.microprofile.openapi.models.Operation	getPATCH()
org.eclipse.microprofile.openapi.models.Operation	getPOST()
org.eclipse.microprofile.openapi.models.Operation	getPUT()
String	getRef()
List<org.eclipse.microprofile.openapi.models.servers.Server>	getServers()
String	getSummary()
org.eclipse.microprofile.openapi.models.Operation	getTRACE()
void	removeParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)
void	removeServer(org.eclipse.microprofile.openapi.models.servers.Server server)
void	setDELETE(org.eclipse.microprofile.openapi.models.Operation delete)
void	setDescription(String description)
void	setGET(org.eclipse.microprofile.openapi.models.Operation get)
void	setHEAD(org.eclipse.microprofile.openapi.models.Operation head)
void	setOperation(org.eclipse.microprofile.openapi.models.PathItem.HttpMethod httpMethod, org.eclipse.microprofile.openapi.models.Operation operation) Method is from MP OpenAPI 2.0.
void	setOPTIONS(org.eclipse.microprofile.openapi.models.Operation options)
void	setParameters(List<org.eclipse.microprofile.openapi.models.parameters.Parameter> parameters)
void	setPATCH(org.eclipse.microprofile.openapi.models.Operation patch)
void	setPOST(org.eclipse.microprofile.openapi.models.Operation post)
void	setPUT(org.eclipse.microprofile.openapi.models.Operation put)
void	setRef(String ref)
void	setServers(List<org.eclipse.microprofile.openapi.models.servers.Server> servers)
void	setSummary(String summary)
void	setTRACE(org.eclipse.microprofile.openapi.models.Operation trace)
org.eclipse.microprofile.openapi.models.PathItem	summary(String summary)

Methods inherited from class io.smallrye.openapi.api.models.ExtensibleImpl

addExtension, getExtensions, removeExtension, setExtensions

Methods inherited from class java.lang.Object

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

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

DELETE, description, GET, HEAD, OPTIONS, parameters, PATCH, POST, PUT, readOperations, readOperationsMap, servers, TRACE

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

addExtension, extensions, getExtensions, removeExtension, setExtensions

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

ref

Constructor Detail

PathItemImpl

public PathItemImpl()

Method Detail

getRef

public String getRef()

Specified by:

getRef in interface org.eclipse.microprofile.openapi.models.Reference<org.eclipse.microprofile.openapi.models.PathItem>

See Also:

Reference.getRef()

setRef

public void setRef(String ref)

Specified by:

setRef in interface org.eclipse.microprofile.openapi.models.Reference<org.eclipse.microprofile.openapi.models.PathItem>

See Also:

Reference.setRef(java.lang.String)

getSummary

public String getSummary()

Specified by:

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

See Also:

PathItem.getSummary()

setSummary

public void setSummary(String summary)

Specified by:

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

See Also:

PathItem.setSummary(java.lang.String)

summary

public org.eclipse.microprofile.openapi.models.PathItem summary(String summary)

Specified by:

summary in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.summary(java.lang.String)

getDescription

public String getDescription()

Specified by:

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

See Also:

PathItem.getDescription()

setDescription

public void setDescription(String description)

Specified by:

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

See Also:

PathItem.setDescription(java.lang.String)

getGET

public org.eclipse.microprofile.openapi.models.Operation getGET()

Specified by:

getGET in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.getGET()

setGET

public void setGET(org.eclipse.microprofile.openapi.models.Operation get)

Specified by:

setGET in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.setGET(org.eclipse.microprofile.openapi.models.Operation)

getPUT

public org.eclipse.microprofile.openapi.models.Operation getPUT()

Specified by:

getPUT in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.getPUT()

setPUT

public void setPUT(org.eclipse.microprofile.openapi.models.Operation put)

Specified by:

setPUT in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.setPUT(org.eclipse.microprofile.openapi.models.Operation)

getPOST

public org.eclipse.microprofile.openapi.models.Operation getPOST()

Specified by:

getPOST in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.getPOST()

setPOST

public void setPOST(org.eclipse.microprofile.openapi.models.Operation post)

Specified by:

setPOST in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.setPOST(org.eclipse.microprofile.openapi.models.Operation)

getDELETE

public org.eclipse.microprofile.openapi.models.Operation getDELETE()

Specified by:

getDELETE in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.getDELETE()

setDELETE

public void setDELETE(org.eclipse.microprofile.openapi.models.Operation delete)

Specified by:

setDELETE in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.setDELETE(org.eclipse.microprofile.openapi.models.Operation)

getOPTIONS

public org.eclipse.microprofile.openapi.models.Operation getOPTIONS()

Specified by:

getOPTIONS in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.getOPTIONS()

setOPTIONS

public void setOPTIONS(org.eclipse.microprofile.openapi.models.Operation options)

Specified by:

setOPTIONS in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.setOPTIONS(org.eclipse.microprofile.openapi.models.Operation)

getHEAD

public org.eclipse.microprofile.openapi.models.Operation getHEAD()

Specified by:

getHEAD in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.getHEAD()

setHEAD

public void setHEAD(org.eclipse.microprofile.openapi.models.Operation head)

Specified by:

setHEAD in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.setHEAD(org.eclipse.microprofile.openapi.models.Operation)

getPATCH

public org.eclipse.microprofile.openapi.models.Operation getPATCH()

Specified by:

getPATCH in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.getPATCH()

setPATCH

public void setPATCH(org.eclipse.microprofile.openapi.models.Operation patch)

Specified by:

setPATCH in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.setPATCH(org.eclipse.microprofile.openapi.models.Operation)

getTRACE

public org.eclipse.microprofile.openapi.models.Operation getTRACE()

Specified by:

getTRACE in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.getTRACE()

setTRACE

public void setTRACE(org.eclipse.microprofile.openapi.models.Operation trace)

Specified by:

setTRACE in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.setTRACE(org.eclipse.microprofile.openapi.models.Operation)

getOperations

public Map<org.eclipse.microprofile.openapi.models.PathItem.HttpMethod,org.eclipse.microprofile.openapi.models.Operation> getOperations()

Specified by:

getOperations in interface org.eclipse.microprofile.openapi.models.PathItem

See Also:

PathItem.getOperations()

setOperation

public void setOperation(org.eclipse.microprofile.openapi.models.PathItem.HttpMethod httpMethod,
                         org.eclipse.microprofile.openapi.models.Operation operation)

Method is from MP OpenAPI 2.0. See Microprofile JavaDoc. org.eclipse.microprofile.openapi.models.PathItem#setOperation(PathItem.HttpMethod, Operation)

getServers

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

Specified by:

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

See Also:

PathItem.getServers()

setServers

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

Specified by:

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

See Also:

PathItem.setServers(java.util.List)

addServer

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

Specified by:

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

See Also:

PathItem.addServer(org.eclipse.microprofile.openapi.models.servers.Server)

removeServer

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

Specified by:

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

See Also:

PathItem.removeServer(org.eclipse.microprofile.openapi.models.servers.Server)

getParameters

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

Specified by:

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

See Also:

PathItem.getParameters()

setParameters

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

Specified by:

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

See Also:

PathItem.setParameters(java.util.List)

addParameter

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

Specified by:

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

See Also:

PathItem.addParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter)

removeParameter

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

Specified by:

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

See Also:

PathItem.removeParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter)