io.smallrye.openapi.runtime.scanner

Class ResourceParameters

java.lang.Object

io.smallrye.openapi.runtime.scanner.ResourceParameters

public class ResourceParameters
extends Object

Result object returned to the annotation scanner. Parameters are split between those that apply at the PathItem level and those that apply at the Operation level, except for form parameters which only apply to the operation. This object includes the class and method path which may have been modified from the values specified by JAX-RS Path or Spring Mapping annotations to support the linkage of matrix parameters.

Author:

Michael Edgar <michael@xlate.io>

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<org.eclipse.microprofile.openapi.models.parameters.Parameter>	PARAMETER_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
ResourceParameters()

Method Summary

Modifier and Type	Method and Description
void	addOperationParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)
List<org.eclipse.microprofile.openapi.models.parameters.Parameter>	getAllParameters()
org.eclipse.microprofile.openapi.models.media.Content	getFormBodyContent()
org.eclipse.microprofile.openapi.models.media.Schema	getFormBodySchema()
String	getFullOperationPath()
List<org.eclipse.microprofile.openapi.models.parameters.Parameter>	getOperationParameters()
String	getOperationPath()
List<org.eclipse.microprofile.openapi.models.parameters.Parameter>	getPathItemParameters()
List<String>	getPathParameterTemplateNames()
void	setFormBodyContent(org.eclipse.microprofile.openapi.models.media.Content formBodyContent)
void	setOperationParameters(List<org.eclipse.microprofile.openapi.models.parameters.Parameter> operationParameters)
void	setOperationPath(String operationPath)
void	setPathItemParameters(List<org.eclipse.microprofile.openapi.models.parameters.Parameter> pathItemParameters)
void	setPathItemPath(String pathItemPath)
void	sort()

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_COMPARATOR

public static final Comparator<org.eclipse.microprofile.openapi.models.parameters.Parameter> PARAMETER_COMPARATOR

Constructor Detail

ResourceParameters

public ResourceParameters()

Method Detail

getPathItemParameters

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

getOperationPath

public String getOperationPath()

getFullOperationPath

public String getFullOperationPath()

getOperationParameters

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

addOperationParameter

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

getFormBodyContent

public org.eclipse.microprofile.openapi.models.media.Content getFormBodyContent()

getFormBodySchema

public org.eclipse.microprofile.openapi.models.media.Schema getFormBodySchema()

getAllParameters

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

setPathItemPath

public void setPathItemPath(String pathItemPath)

setPathItemParameters

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

setOperationPath

public void setOperationPath(String operationPath)

setOperationParameters

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

setFormBodyContent

public void setFormBodyContent(org.eclipse.microprofile.openapi.models.media.Content formBodyContent)

sort

public void sort()

getPathParameterTemplateNames

public List<String> getPathParameterTemplateNames()