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.repository;
20
21 import java.util.function.BiFunction;
22
23 /**
24 * The repository key function, it produces keys (strings) for given {@link RemoteRepository} instances.
25 *
26 * @since 2.0.14
27 */
28 @FunctionalInterface
29 public interface RepositoryKeyFunction extends BiFunction<RemoteRepository, String, String> {
30 /**
31 * Produces a string representing "repository key" for given {@link RemoteRepository} and
32 * optionally (maybe {@code null}) "context".
33 *
34 * @param repository The {@link RemoteRepository}, may not be {@code null}.
35 * @param context The "context" string, or {@code null}.
36 * @return The "repository key" string, never {@code null}.
37 */
38 @Override
39 String apply(RemoteRepository repository, String context);
40 }