api/maven-api-core/src/main/java/org/apache/maven/api/Repository.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.maven.api;

import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Immutable;
import org.apache.maven.api.annotations.Nonnull;

/**
 * A repository holds artifacts.
 *
 * @since 4.0.0
 * @see RemoteRepository
 * @see LocalRepository
 */
@Experimental
@Immutable
public interface Repository {

    /**
     * The reserved id for Maven Central
     */
    String CENTRAL_ID = "central";

    /**
     * Gets the identifier of this repository.
     *
     * @return the (case-sensitive) identifier, never {@code null}
     */
    @Nonnull
    String getId();

    /**
     * Gets the type of the repository, for example "default".
     *
     * @return the (case-sensitive) type of the repository, never {@code null}
     */
    @Nonnull
    String getType();
}