ReaderExtension (swagger-servlet 1.5.24-mapr API)

All Known Implementing Classes:

ServletReaderExtension
```
public interface ReaderExtension
```
The ReaderExtension interface defines methods for scans resources for Swagger.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`applyConsumes(ReaderContext context, Operation operation, java.lang.reflect.Method method)` Reads the consumes from the method's annotations and applies these to the operation.
`void`	`applyDescription(Operation operation, java.lang.reflect.Method method)` Reads the description from the method's annotations and applies it to the operation.
`void`	`applyExtensions(ReaderContext context, Operation operation, java.lang.reflect.Method method)` Reads the extensions from the method's annotations and applies these to the operation.
`void`	`applyImplicitParameters(ReaderContext context, Operation operation, java.lang.reflect.Method method)` Reads the implicit parameters from the method's annotations and applies these to the operation.
`void`	`applyOperationId(Operation operation, java.lang.reflect.Method method)` Reads the operation id from the method's annotations and applies it to the operation.
`void`	`applyParameters(ReaderContext context, Operation operation, java.lang.reflect.Type type, java.lang.annotation.Annotation[] annotations)` Reads the parameters from the method's annotations and applies these to the operation.
`void`	`applyProduces(ReaderContext context, Operation operation, java.lang.reflect.Method method)` Reads the produces from the method's annotations and applies these to the operation.
`void`	`applyResponses(ReaderContext context, Operation operation, java.lang.reflect.Method method)` Reads the responses from the method's annotations and applies these to the operation.
`void`	`applySchemes(ReaderContext context, Operation operation, java.lang.reflect.Method method)` Reads the schemes from the method's annotations and applies these to the operation.
`void`	`applySecurityRequirements(ReaderContext context, Operation operation, java.lang.reflect.Method method)` Reads the security requirement from the method's annotations and applies these to the operation.
`void`	`applySummary(Operation operation, java.lang.reflect.Method method)` Reads the summary from the method's annotations and applies it to the operation.
`void`	`applyTags(ReaderContext context, Operation operation, java.lang.reflect.Method method)` Reads the tags from the method's annotations and applies these to the operation.
`java.lang.String`	`getHttpMethod(ReaderContext context, java.lang.reflect.Method method)` Returns http method.
`java.lang.String`	`getPath(ReaderContext context, java.lang.reflect.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, java.lang.reflect.Method method)` Sets the deprecated flag to the operation.

- Method Detail
  - getPriority
```
int getPriority()
```
    Returns this extension's priority. Note: Extension will be executed first with lowest priority.
    
    Returns:
    
    this extension's priority
  - isReadable
```
boolean isReadable(ReaderContext context)
```
    Checks that a resource should be scanned.
    
    Parameters:
    
    context - is the resource context
    
    Returns:
    
    true if the resource needs to be scanned, otherwise false
  - applyConsumes
```
void applyConsumes(ReaderContext context,
                   Operation operation,
                   java.lang.reflect.Method method)
```
    Reads the consumes from the method's annotations and applies these to the operation.
    
    Parameters:
    
    context - is the resource context
    
    operation - is the container for the operation data
    
    method - is the method for reading annotations
  - applyProduces
```
void applyProduces(ReaderContext context,
                   Operation operation,
                   java.lang.reflect.Method method)
```
    Reads the produces from the method's annotations and applies these to the operation.
    
    Parameters:
    
    context - is the resource context
    
    operation - is the container for the operation data
    
    method - is the method for reading annotations
  - getHttpMethod
```
java.lang.String getHttpMethod(ReaderContext context,
                               java.lang.reflect.Method method)
```
    Returns http method.
    
    Parameters:
    
    context - is the resource context
    
    method - is the method for reading annotations
    
    Returns:
    
    http method
  - getPath
```
java.lang.String getPath(ReaderContext context,
                         java.lang.reflect.Method method)
```
    Returns operation's path.
    
    Parameters:
    
    context - is the resource context
    
    method - is the method for reading annotations
    
    Returns:
    
    operation's path
  - applyOperationId
```
void applyOperationId(Operation operation,
                      java.lang.reflect.Method method)
```
    Reads the operation id from the method's annotations and applies it to the operation.
    
    Parameters:
    
    operation - is the container for the operation data
    
    method - is the method for reading annotations
  - applySummary
```
void applySummary(Operation operation,
                  java.lang.reflect.Method method)
```
    Reads the summary from the method's annotations and applies it to the operation.
    
    Parameters:
    
    operation - is the container for the operation data
    
    method - is the method for reading annotations
  - applyDescription
```
void applyDescription(Operation operation,
                      java.lang.reflect.Method method)
```
    Reads the description from the method's annotations and applies it to the operation.
    
    Parameters:
    
    operation - is the container for the operation data
    
    method - is the method for reading annotations
  - applySchemes
```
void applySchemes(ReaderContext context,
                  Operation operation,
                  java.lang.reflect.Method method)
```
    Reads the schemes from the method's annotations and applies these to the operation.
    
    Parameters:
    
    context - is the resource context
    
    operation - is the container for the operation data
    
    method - is the method for reading annotations
  - setDeprecated
```
void setDeprecated(Operation operation,
                   java.lang.reflect.Method method)
```
    Sets the deprecated flag to the operation.
    
    Parameters:
    
    operation - is the container for the operation data
    
    method - is the method for reading annotations
  - applySecurityRequirements
```
void applySecurityRequirements(ReaderContext context,
                               Operation operation,
                               java.lang.reflect.Method method)
```
    Reads the security requirement from the method's annotations and applies these to the operation.
    
    Parameters:
    
    context - is the resource context
    
    operation - is the container for the operation data
    
    method - is the method for reading annotations
  - applyTags
```
void applyTags(ReaderContext context,
               Operation operation,
               java.lang.reflect.Method method)
```
    Reads the tags from the method's annotations and applies these to the operation.
    
    Parameters:
    
    context - is the resource context
    
    operation - is the container for the operation data
    
    method - is the method for reading annotations
  - applyResponses
```
void applyResponses(ReaderContext context,
                    Operation operation,
                    java.lang.reflect.Method method)
```
    Reads the responses from the method's annotations and applies these to the operation.
    
    Parameters:
    
    context - is the resource context
    
    operation - is the container for the operation data
    
    method - is the method for reading annotations
  - applyParameters
```
void applyParameters(ReaderContext context,
                     Operation operation,
                     java.lang.reflect.Type type,
                     java.lang.annotation.Annotation[] annotations)
```
    Reads the parameters from the method's annotations and applies these to the operation.
    
    Parameters:
    
    context - is the resource context
    
    operation - is the container for the operation data
    
    type - is the type of parameter
    
    annotations - are the method's annotations
  - applyImplicitParameters
```
void applyImplicitParameters(ReaderContext context,
                             Operation operation,
                             java.lang.reflect.Method method)
```
    Reads the implicit parameters from the method's annotations and applies these to the operation.
    
    Parameters:
    
    context - is the resource context
    
    operation - is the container for the operation data
    
    method - is the method for reading annotations
  - applyExtensions
```
void applyExtensions(ReaderContext context,
                     Operation operation,
                     java.lang.reflect.Method method)
```
    Reads the extensions from the method's annotations and applies these to the operation.
    
    Parameters:
    
    context - is the resource context
    
    operation - is the container for the operation data
    
    method - is the method for reading annotations

Interface ReaderExtension

Method Summary

Method Detail

getPriority

isReadable

applyConsumes

applyProduces

getHttpMethod

getPath

applyOperationId

applySummary

applyDescription

applySchemes

setDeprecated

applySecurityRequirements

applyTags

applyResponses

applyParameters

applyImplicitParameters

applyExtensions