Package org.openapitools.codegen

Class OpenAPINormalizer.Filter

java.lang.Object

org.openapitools.codegen.OpenAPINormalizer.BaseFilter

org.openapitools.codegen.OpenAPINormalizer.Filter

Enclosing class:

OpenAPINormalizer

protected static class OpenAPINormalizer.Filter
extends OpenAPINormalizer.BaseFilter

Field Summary

Fields

Modifier and Type	Field	Description
static String	METHOD
protected Set<String>	methodFilters
static String	OPERATION_ID
protected Set<String>	operationIdFilters
static String	PATH
protected Set<String>	pathStartingWithFilters
static String	TAG
protected Set<String>	tagFilters

Fields inherited from class org.openapitools.codegen.OpenAPINormalizer.BaseFilter

filteringMethodsMap, hasFilter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Filter(String filters)

Method Summary

Modifier and Type	Method	Description
void	apply(String path, io.swagger.v3.oas.models.PathItem pathItem, Map<String,Function<io.swagger.v3.oas.models.PathItem,io.swagger.v3.oas.models.Operation>> methodMap)
Set<String>	filteringMethods()
protected boolean	hasCustomFilterMatch(String path, io.swagger.v3.oas.models.Operation operation)	Test if the OpenAPI contract match an extra filter.
protected boolean	logIfMatch(String filterName, io.swagger.v3.oas.models.Operation operation, boolean filterMatched)
protected void	logMatch(String filterName, io.swagger.v3.oas.models.Operation operation)
protected void	logMatch(String filterName, String subjectId)
boolean	parse()	Perform the parsing of the filter string.
String	usageMessage()

Methods inherited from class org.openapitools.codegen.OpenAPINormalizer.BaseFilter

getLogger, hasFilter, logIfMatch, parse, parseFails, splitByPipe

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_ID

public static final String OPERATION_ID

See Also:

Constant Field Values

METHOD

public static final String METHOD

See Also:

Constant Field Values

TAG

public static final String TAG

See Also:

Constant Field Values

PATH

public static final String PATH

See Also:

Constant Field Values

operationIdFilters

protected Set<String> operationIdFilters

methodFilters

protected Set<String> methodFilters

tagFilters

protected Set<String> tagFilters

pathStartingWithFilters

protected Set<String> pathStartingWithFilters

Constructor Detail

Filter

protected Filter(String filters)

Method Detail

filteringMethods

public Set<String> filteringMethods()

Specified by:

filteringMethods in class OpenAPINormalizer.BaseFilter

usageMessage

public String usageMessage()

Specified by:

usageMessage in class OpenAPINormalizer.BaseFilter

logMatch

protected void logMatch(String filterName,
                        String subjectId)

Specified by:

logMatch in class OpenAPINormalizer.BaseFilter

parse

public boolean parse()

Description copied from class: OpenAPINormalizer.BaseFilter

Perform the parsing of the filter string.

Overrides:

parse in class OpenAPINormalizer.BaseFilter

Returns:

true if filters need to be processed

logIfMatch

protected boolean logIfMatch(String filterName,
                             io.swagger.v3.oas.models.Operation operation,
                             boolean filterMatched)

logMatch

protected void logMatch(String filterName,
                        io.swagger.v3.oas.models.Operation operation)

hasCustomFilterMatch

protected boolean hasCustomFilterMatch(String path,
                                       io.swagger.v3.oas.models.Operation operation)

Test if the OpenAPI contract match an extra filter. Override this method to add custom logic.

Parameters:

operation - Openapi Operation

path - Path of the operation

Returns:

true if the operation of path match the filter

apply

public void apply(String path,
                  io.swagger.v3.oas.models.PathItem pathItem,
                  Map<String,Function<io.swagger.v3.oas.models.PathItem,io.swagger.v3.oas.models.Operation>> methodMap)