001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.collection;
020
021import java.util.Optional;
022import java.util.function.Function;
023
024import org.eclipse.aether.version.VersionConstraint;
025
026/**
027 * Builds {@link VersionFilter} instances out of input expression string.
028 *
029 * @since 2.0.18
030 */
031public interface VersionFilterBuilder {
032    /**
033     * Config property for version filter suppression. Presence of this key will suppress filter created by this builder.
034     * This key is not meant for users, but to programmatically signal filtering suppression.
035     */
036    String VERSION_FILTER_SUPPRESSED = "aether.versionFilter.suppressed";
037
038    /**
039     * Builds a version filter based on the given filter expression.
040     *
041     * @param filterExpression a string containing filter expressions, may be {@code null}.
042     * @param versionConstraintParser version constraint parts to be used during parsing, must not be {@code null}.
043     * @return optional version filter, never {@code null}.
044     */
045    Optional<VersionFilter> buildVersionFilter(
046            String filterExpression, Function<String, VersionConstraint> versionConstraintParser);
047}