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.repository;
020
021import java.util.function.BiFunction;
022
023/**
024 * The repository key function, it produces keys (strings) for given {@link RemoteRepository} instances.
025 *
026 * @since 2.0.14
027 */
028@FunctionalInterface
029public interface RepositoryKeyFunction extends BiFunction<RemoteRepository, String, String> {
030    /**
031     * Produces a string representing "repository key" for given {@link RemoteRepository} and
032     * optionally (maybe {@code null}) "context".
033     *
034     * @param repository The {@link RemoteRepository}, may not be {@code null}.
035     * @param context    The "context" string, or {@code null}.
036     * @return The "repository key" string, never {@code null}.
037     */
038    @Override
039    String apply(RemoteRepository repository, String context);
040}