1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.eclipse.aether.collection;
20
21 import java.util.Optional;
22 import java.util.function.Function;
23
24 import org.eclipse.aether.version.VersionConstraint;
25
26 /**
27 * Builds {@link VersionFilter} instances out of input expression string.
28 *
29 * @since 2.0.18
30 */
31 public interface VersionFilterBuilder {
32 /**
33 * Config property for version filter suppression. Presence of this key will suppress filter created by this builder.
34 * This key is not meant for users, but to programmatically signal filtering suppression.
35 */
36 String VERSION_FILTER_SUPPRESSED = "aether.versionFilter.suppressed";
37
38 /**
39 * Builds a version filter based on the given filter expression.
40 *
41 * @param filterExpression a string containing filter expressions, may be {@code null}.
42 * @param versionConstraintParser version constraint parts to be used during parsing, must not be {@code null}.
43 * @return optional version filter, never {@code null}.
44 */
45 Optional<VersionFilter> buildVersionFilter(
46 String filterExpression, Function<String, VersionConstraint> versionConstraintParser);
47 }