public class ServletReaderExtension extends Object implements ReaderExtension
Constructor and Description |
---|
ServletReaderExtension() |
Modifier and Type | Method and Description |
---|---|
void |
applyConsumes(ReaderContext context,
Operation operation,
Method method)
Reads the consumes from the method's annotations and applies these to the operation.
|
void |
applyDescription(Operation operation,
Method method)
Reads the description from the method's annotations and applies it to the operation.
|
void |
applyExtensions(ReaderContext context,
Operation operation,
Method method)
Reads the extensions from the method's annotations and applies these to the operation.
|
void |
applyImplicitParameters(ReaderContext context,
Operation operation,
Method method)
Reads the implicit parameters from the method's annotations and applies these to the operation.
|
void |
applyOperationId(Operation operation,
Method method)
Reads the operation id from the method's annotations and applies it to the operation.
|
void |
applyParameters(ReaderContext context,
Operation operation,
Type type,
Annotation[] annotations)
Reads the parameters from the method's annotations and applies these to the operation.
|
void |
applyProduces(ReaderContext context,
Operation operation,
Method method)
Reads the produces from the method's annotations and applies these to the operation.
|
void |
applyResponses(ReaderContext context,
Operation operation,
Method method)
Reads the responses from the method's annotations and applies these to the operation.
|
void |
applySchemes(ReaderContext context,
Operation operation,
Method method)
Reads the schemes from the method's annotations and applies these to the operation.
|
void |
applySecurityRequirements(ReaderContext context,
Operation operation,
Method method)
Reads the security requirement from the method's annotations and applies these to the operation.
|
void |
applySummary(Operation operation,
Method method)
Reads the summary from the method's annotations and applies it to the operation.
|
void |
applyTags(ReaderContext context,
Operation operation,
Method method)
Reads the tags from the method's annotations and applies these to the operation.
|
String |
getHttpMethod(ReaderContext context,
Method method)
Returns http method.
|
String |
getPath(ReaderContext context,
Method method)
Returns operation's path.
|
int |
getPriority()
Returns this extension's priority.
|
boolean |
isReadable(ReaderContext context)
Checks that a resource should be scanned.
|
void |
setDeprecated(Operation operation,
Method method)
Sets the deprecated flag to the operation.
|
public int getPriority()
ReaderExtension
getPriority
in interface ReaderExtension
public boolean isReadable(ReaderContext context)
ReaderExtension
isReadable
in interface ReaderExtension
context
- is the resource contextpublic void applyConsumes(ReaderContext context, Operation operation, Method method)
ReaderExtension
applyConsumes
in interface ReaderExtension
context
- is the resource contextoperation
- is the container for the operation datamethod
- is the method for reading annotationspublic void applyProduces(ReaderContext context, Operation operation, Method method)
ReaderExtension
applyProduces
in interface ReaderExtension
context
- is the resource contextoperation
- is the container for the operation datamethod
- is the method for reading annotationspublic String getHttpMethod(ReaderContext context, Method method)
ReaderExtension
getHttpMethod
in interface ReaderExtension
context
- is the resource contextmethod
- is the method for reading annotationspublic String getPath(ReaderContext context, Method method)
ReaderExtension
getPath
in interface ReaderExtension
context
- is the resource contextmethod
- is the method for reading annotationspublic void applyOperationId(Operation operation, Method method)
ReaderExtension
applyOperationId
in interface ReaderExtension
operation
- is the container for the operation datamethod
- is the method for reading annotationspublic void applySummary(Operation operation, Method method)
ReaderExtension
applySummary
in interface ReaderExtension
operation
- is the container for the operation datamethod
- is the method for reading annotationspublic void applyDescription(Operation operation, Method method)
ReaderExtension
applyDescription
in interface ReaderExtension
operation
- is the container for the operation datamethod
- is the method for reading annotationspublic void applySchemes(ReaderContext context, Operation operation, Method method)
ReaderExtension
applySchemes
in interface ReaderExtension
context
- is the resource contextoperation
- is the container for the operation datamethod
- is the method for reading annotationspublic void setDeprecated(Operation operation, Method method)
ReaderExtension
setDeprecated
in interface ReaderExtension
operation
- is the container for the operation datamethod
- is the method for reading annotationspublic void applySecurityRequirements(ReaderContext context, Operation operation, Method method)
ReaderExtension
applySecurityRequirements
in interface ReaderExtension
context
- is the resource contextoperation
- is the container for the operation datamethod
- is the method for reading annotationspublic void applyTags(ReaderContext context, Operation operation, Method method)
ReaderExtension
applyTags
in interface ReaderExtension
context
- is the resource contextoperation
- is the container for the operation datamethod
- is the method for reading annotationspublic void applyResponses(ReaderContext context, Operation operation, Method method)
ReaderExtension
applyResponses
in interface ReaderExtension
context
- is the resource contextoperation
- is the container for the operation datamethod
- is the method for reading annotationspublic void applyParameters(ReaderContext context, Operation operation, Type type, Annotation[] annotations)
ReaderExtension
applyParameters
in interface ReaderExtension
context
- is the resource contextoperation
- is the container for the operation datatype
- is the type of parameterannotations
- are the method's annotationspublic void applyImplicitParameters(ReaderContext context, Operation operation, Method method)
ReaderExtension
applyImplicitParameters
in interface ReaderExtension
context
- is the resource contextoperation
- is the container for the operation datamethod
- is the method for reading annotationspublic void applyExtensions(ReaderContext context, Operation operation, Method method)
ReaderExtension
applyExtensions
in interface ReaderExtension
context
- is the resource contextoperation
- is the container for the operation datamethod
- is the method for reading annotationsCopyright © 2020 JBoss by Red Hat. All Rights Reserved.