001package org.eclipse.aether.repository;
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 java.io.File;
023import java.util.List;
024
025import org.eclipse.aether.artifact.Artifact;
026
027/**
028 * Manages a repository backed by the IDE workspace, a build session or a similar ad-hoc collection of artifacts.
029 * 
030 * @see org.eclipse.aether.RepositorySystemSession#getWorkspaceReader()
031 */
032public interface WorkspaceReader
033{
034
035    /**
036     * Gets a description of the workspace repository.
037     * 
038     * @return The repository description, never {@code null}.
039     */
040    WorkspaceRepository getRepository();
041
042    /**
043     * Locates the specified artifact.
044     * 
045     * @param artifact The artifact to locate, must not be {@code null}.
046     * @return The path to the artifact or {@code null} if the artifact is not available.
047     */
048    File findArtifact( Artifact artifact );
049
050    /**
051     * Determines all available versions of the specified artifact.
052     * 
053     * @param artifact The artifact whose versions should be listed, must not be {@code null}.
054     * @return The available versions of the artifact, must not be {@code null}.
055     */
056    List<String> findVersions( Artifact artifact );
057
058}