001package org.eclipse.aether.internal.impl.synccontext.named;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.eclipse.aether.RepositorySystemSession;
023import org.eclipse.aether.artifact.Artifact;
024import org.eclipse.aether.metadata.Metadata;
025
026import java.util.Collection;
027
028/**
029 * Component mapping lock names to passed in artifacts and metadata as required.
030 */
031public interface NameMapper
032{
033    /**
034     * Creates (opaque) names for passed in artifacts and metadata. Returned collection has max size of sum of the
035     * passed in artifacts and metadata collections, or less. If an empty collection is returned, there will be no
036     * locking happening. Never returns {@code null}. The resulting collection MUST BE "stable" (always sorted by
037     * same criteria) to avoid deadlocks by acquiring locks in same order, essentially disregarding the order of
038     * the input collections.
039     */
040    Collection<String> nameLocks( RepositorySystemSession session, Collection<? extends Artifact> artifacts,
041                                  Collection<? extends Metadata> metadatas );
042}