1 package org.eclipse.aether.repository;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.io.File;
23 import java.util.List;
24
25 import org.eclipse.aether.artifact.Artifact;
26
27 /**
28 * Manages a repository backed by the IDE workspace, a build session or a similar ad-hoc collection of artifacts.
29 *
30 * @see org.eclipse.aether.RepositorySystemSession#getWorkspaceReader()
31 */
32 public interface WorkspaceReader
33 {
34
35 /**
36 * Gets a description of the workspace repository.
37 *
38 * @return The repository description, never {@code null}.
39 */
40 WorkspaceRepository getRepository();
41
42 /**
43 * Locates the specified artifact.
44 *
45 * @param artifact The artifact to locate, must not be {@code null}.
46 * @return The path to the artifact or {@code null} if the artifact is not available.
47 */
48 File findArtifact( Artifact artifact );
49
50 /**
51 * Determines all available versions of the specified artifact.
52 *
53 * @param artifact The artifact whose versions should be listed, must not be {@code null}.
54 * @return The available versions of the artifact, must not be {@code null}.
55 */
56 List<String> findVersions( Artifact artifact );
57
58 }