/
PathItemFilter.java
43 lines (40 loc) · 1.48 KB
/
PathItemFilter.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
/*-
* #%L
* OpenAPI Generator for Spring Boot :: API
* %%
* Copyright (C) 2020 QAware GmbH
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
package de.qaware.openapigeneratorforspring.common.filter.pathitem;
import de.qaware.openapigeneratorforspring.model.path.PathItem;
/**
* Filter for path items. Run AFTER the {@link PathItem path item} is built.
*
* <p>This filter does not remove possibly referenced
* items due to operation building. Prefer using {@link
* de.qaware.openapigeneratorforspring.common.filter.handlermethod.HandlerMethodFilter
* HandlerMethodFilter} whenever possible.
*/
@FunctionalInterface
public interface PathItemFilter {
/**
* Accept the given path item to become part of the OpenApi model.
*
* @param pathItem built path item
* @param pathPattern path pattern this path item is built for
* @return true if path item shall be included, false otherwise
*/
boolean accept(PathItem pathItem, String pathPattern);
}