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.apache.maven.api;
20
21 import org.apache.maven.api.annotations.Nonnull;
22
23 /**
24 * Represents a repository backed by an IDE workspace, the output of a build session,
25 * or similar ad-hoc collections of artifacts. This repository is considered read-only
26 * within the context of a session, meaning it can only be used for artifact resolution,
27 * not for installation or deployment. This interface does not provide direct access
28 * to artifacts; that functionality is handled by a {@code WorkspaceReader}.
29 */
30 public interface WorkspaceRepository extends Repository {
31
32 /**
33 * {@return the type of the repository, i.e. "workspace"}
34 */
35 @Nonnull
36 @Override
37 default String getType() {
38 return "workspace";
39 }
40 }