AbstractAnnotationScanner (SmallRye: OpenAPI Core 3.0.0-RC4 API)

java.lang.Object
- io.smallrye.openapi.runtime.scanner.spi.AbstractAnnotationScanner

All Implemented Interfaces:

AnnotationScanner
```
public abstract class AbstractAnnotationScanner
extends Object
implements AnnotationScanner
```
Abstract base class for annotation scanners

Author:

Phillip Kruger ([email protected])

Field Summary

Fields
Modifier and Type Field Description

protected String currentAppPath

Constructor Summary

Constructors
Constructor Description

AbstractAnnotationScanner()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected static String`	`createPathFromSegments(String... segments)`	Make a path out of a number of path segments.
`protected String`	`makePath(String operationPath)`
`protected static boolean`	`processProfiles(OpenApiConfig config, org.eclipse.microprofile.openapi.models.Extensible<?> extensible)`	Checks if the given extensible contains profiles, and if the extensible should be included in the final openapi document.
`void`	`setContextRoot(String path)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.smallrye.openapi.runtime.scanner.spi.AnnotationScanner
addApiReponseFromAnnotation, addApiReponseSchemaFromAnnotation, clearJsonViewContext, containsScannerAnnotations, createResponseFromRestMethod, generateResponse, getConsumes, getDefaultStatus, getKotlinContinuationArgument, getName, getReasonPhrase, getRequestBodyParameterClassType, getResourceMethods, hasKotlinContinuation, isAsyncResponse, isDeleteMethod, isEmptySecurityRequirements, isKotlinContinuation, isMultipartInput, isMultipartOutput, isPathParameter, isPostMethod, isScannerInternalParameter, isScannerInternalResponse, isScannerInternalResponse, isVoidResponse, isWrapperType, kotlinContinuationToSchema, processCallback, processDefinitionAnnotation, processExtensions, processJavaSecurity, processOperation, processOperationTags, processRequestBody, processResponse, processScannerExtensions, processSecurityRequirementAnnotation, processSecuritySchemeAnnotation, processServerAnnotation, processServerAnnotation, processTags, responseCodeExistInMethodAnnotations, scan, setJsonViewContext, setOperationOnPathItem, setRequestBodyConstraints, unwrapType

- Field Detail
  - currentAppPath
```
protected String currentAppPath
```
- Constructor Detail
  - AbstractAnnotationScanner
```
public AbstractAnnotationScanner()
```
- Method Detail
  - setContextRoot
```
public void setContextRoot(String path)
```
    Specified by:
    
    setContextRoot in interface AnnotationScanner
  - makePath
```
protected String makePath(String operationPath)
```
  - createPathFromSegments
```
protected static String createPathFromSegments(String... segments)
```
    Make a path out of a number of path segments.
    
    Parameters:
    
    segments - String paths
    
    Returns:
    
    Path built from the segments
  - processProfiles
```
protected static boolean processProfiles(OpenApiConfig config,
                                         org.eclipse.microprofile.openapi.models.Extensible<?> extensible)
```
    Checks if the given extensible contains profiles, and if the extensible should be included in the final openapi document. Any extension containing a profile is removed from the extensible. inclusion is then calculated based on all collected profiles.
    
    Parameters:
    
    config - current config
    
    extensible - the extensible to check for profiles
    
    Returns:
    
    true, if the given extensible should be included in the final openapi document, otherwise false