org.springdoc.core.fn

Class RouterOperation

java.lang.Object

org.springdoc.core.fn.RouterOperation

All Implemented Interfaces:

Comparable<RouterOperation>

public class RouterOperation
extends Object
implements Comparable<RouterOperation>

The type Router operation.

Author:

bnasslahsen, hyeonisism

Constructor Summary

Constructors

Constructor and Description
RouterOperation() Instantiates a new Router operation.
RouterOperation(RouterFunctionData routerFunctionData) Instantiates a new Router operation.
RouterOperation(RouterOperation routerOperationAnnotation) Instantiates a new Router operation.
RouterOperation(RouterOperation routerOperation, org.springframework.web.bind.annotation.RequestMethod requestMethod) Instantiates a new Router operation.
RouterOperation(RouterOperation routerOperationAnnotation, RouterFunctionData routerFunctionData) Instantiates a new Router operation.
RouterOperation(String path, org.springframework.web.bind.annotation.RequestMethod[] methods, String[] consumes, String[] produces, String[] headers, String[] params) Instantiates a new Router operation.

Method Summary

Modifier and Type	Method and Description
int	compareTo(RouterOperation routerOperation)
boolean	equals(Object o)
Class<?>	getBeanClass() Gets bean class.
String	getBeanMethod() Gets bean method.
String[]	getConsumes() Get consumes string [ ].
String[]	getHeaders() Get headers string [ ].
org.springframework.web.bind.annotation.RequestMethod[]	getMethods() Get methods request method [ ].
io.swagger.v3.oas.annotations.Operation	getOperation() Gets operation.
io.swagger.v3.oas.models.Operation	getOperationModel() Gets operation model.
Class<?>[]	getParameterTypes() Get parameter types class [ ].
String[]	getParams() Gets params.
String	getPath() Gets path.
String[]	getProduces() Get produces string [ ].
Map<String,String>	getQueryParams() Gets query params.
int	hashCode()
void	setBeanClass(Class<?> beanClass) Sets bean class.
void	setBeanMethod(String beanMethod) Sets bean method.
void	setConsumes(String[] consumes) Sets consumes.
void	setHeaders(String[] headers) Sets headers.
void	setMethods(org.springframework.web.bind.annotation.RequestMethod[] methods) Sets methods.
void	setOperation(io.swagger.v3.oas.annotations.Operation operation) Sets operation.
void	setOperationModel(io.swagger.v3.oas.models.Operation operationModel) Sets operation model.
void	setParameterTypes(Class<?>[] parameterTypes) Sets parameter types.
void	setParams(String[] params) Sets params.
void	setPath(String path) Sets path.
void	setProduces(String[] produces) Sets produces.
void	setQueryParams(Map<String,String> queryParams) Sets query params.

Methods inherited from class java.lang.Object

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

Constructor Detail

RouterOperation

public RouterOperation()

Instantiates a new Router operation.

RouterOperation

public RouterOperation(RouterOperation routerOperationAnnotation)

Instantiates a new Router operation.

Parameters:

routerOperationAnnotation - the router operation annotation

RouterOperation

public RouterOperation(RouterOperation routerOperationAnnotation,
                       RouterFunctionData routerFunctionData)

Instantiates a new Router operation.

Parameters:

routerOperationAnnotation - the router operation annotation

routerFunctionData - the router function data

RouterOperation

public RouterOperation(String path,
                       org.springframework.web.bind.annotation.RequestMethod[] methods,
                       String[] consumes,
                       String[] produces,
                       String[] headers,
                       String[] params)

Instantiates a new Router operation.

Parameters:

path - the path

methods - the methods

consumes - the consumes

produces - the produces

headers - the headers

RouterOperation

public RouterOperation(RouterFunctionData routerFunctionData)

Instantiates a new Router operation.

Parameters:

routerFunctionData - the router function data

RouterOperation

public RouterOperation(RouterOperation routerOperation,
                       org.springframework.web.bind.annotation.RequestMethod requestMethod)

Instantiates a new Router operation.

Parameters:

routerOperation - the router operation

requestMethod - the request method

Method Detail

getPath

public String getPath()

Gets path.

Returns:

the path

setPath

public void setPath(String path)

Sets path.

Parameters:

path - the path

getMethods

public org.springframework.web.bind.annotation.RequestMethod[] getMethods()

Get methods request method [ ].

Returns:

the request method [ ]

setMethods

public void setMethods(org.springframework.web.bind.annotation.RequestMethod[] methods)

Sets methods.

Parameters:

methods - the methods

getConsumes

public String[] getConsumes()

Get consumes string [ ].

Returns:

the string [ ]

setConsumes

public void setConsumes(String[] consumes)

Sets consumes.

Parameters:

consumes - the consumes

getProduces

public String[] getProduces()

Get produces string [ ].

Returns:

the string [ ]

setProduces

public void setProduces(String[] produces)

Sets produces.

Parameters:

produces - the produces

getBeanClass

public Class<?> getBeanClass()

Gets bean class.

Returns:

the bean class

setBeanClass

public void setBeanClass(Class<?> beanClass)

Sets bean class.

Parameters:

beanClass - the bean class

getBeanMethod

public String getBeanMethod()

Gets bean method.

Returns:

the bean method

setBeanMethod

public void setBeanMethod(String beanMethod)

Sets bean method.

Parameters:

beanMethod - the bean method

getParameterTypes

public Class<?>[] getParameterTypes()

Get parameter types class [ ].

Returns:

the class [ ]

setParameterTypes

public void setParameterTypes(Class<?>[] parameterTypes)

Sets parameter types.

Parameters:

parameterTypes - the parameter types

getOperation

public io.swagger.v3.oas.annotations.Operation getOperation()

Gets operation.

Returns:

the operation

setOperation

public void setOperation(io.swagger.v3.oas.annotations.Operation operation)

Sets operation.

Parameters:

operation - the operation

getHeaders

public String[] getHeaders()

Get headers string [ ].

Returns:

the string [ ]

setHeaders

public void setHeaders(String[] headers)

Sets headers.

Parameters:

headers - the headers

getQueryParams

public Map<String,String> getQueryParams()

Gets query params.

Returns:

the query params

setQueryParams

public void setQueryParams(Map<String,String> queryParams)

Sets query params.

Parameters:

queryParams - the query params

getParams

public String[] getParams()

Gets params.

Returns:

the params

setParams

public void setParams(String[] params)

Sets params.

Parameters:

params -

getOperationModel

public io.swagger.v3.oas.models.Operation getOperationModel()

Gets operation model.

Returns:

the operation model

setOperationModel

public void setOperationModel(io.swagger.v3.oas.models.Operation operationModel)

Sets operation model.

Parameters:

operationModel - the operation model

compareTo

public int compareTo(RouterOperation routerOperation)

Specified by:

compareTo in interface Comparable<RouterOperation>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object