View Javadoc
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.Experimental;
22  import org.apache.maven.api.annotations.Immutable;
23  import org.apache.maven.api.annotations.Nonnull;
24  
25  /**
26   * A repository holds artifacts.
27   *
28   * @since 4.0.0
29   * @see RemoteRepository
30   * @see LocalRepository
31   */
32  @Experimental
33  @Immutable
34  public interface Repository {
35  
36      /**
37       * The reserved id for Maven Central
38       */
39      String CENTRAL_ID = "central";
40  
41      /**
42       * Gets the identifier of this repository.
43       *
44       * @return the (case-sensitive) identifier, never {@code null}
45       */
46      @Nonnull
47      String getId();
48  
49      /**
50       * Gets the type of the repository, for example "default".
51       *
52       * @return the (case-sensitive) type of the repository, never {@code null}
53       */
54      @Nonnull
55      String getType();
56  }