org.eclipse.aether.repository.LocalArtifactRegistration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-resolver-api Show documentation
The application programming interface for the repository system.
There is a newer version: 2.0.1
/*
 * 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.eclipse.aether.repository;

import java.util.Collection;
import java.util.Collections;

import org.eclipse.aether.artifact.Artifact;

/**
 * A request to register an artifact within the local repository. Certain local repository implementations can refuse to
 * serve physically present artifacts if those haven't been previously registered to them.
 *
 * @see LocalRepositoryManager#add(org.eclipse.aether.RepositorySystemSession, LocalArtifactRegistration)
 */
public final class LocalArtifactRegistration {

    private Artifact artifact;

    private RemoteRepository repository;

    private Collection contexts = Collections.emptyList();

    /**
     * Creates an uninitialized registration.
     */
    public LocalArtifactRegistration() {
        // enables default constructor
    }

    /**
     * Creates a registration request for the specified (locally installed) artifact.
     *
     * @param artifact The artifact to register, may be {@code null}.
     */
    public LocalArtifactRegistration(Artifact artifact) {
        setArtifact(artifact);
    }

    /**
     * Creates a registration request for the specified artifact.
     *
     * @param artifact The artifact to register, may be {@code null}.
     * @param repository The remote repository from which the artifact was resolved or {@code null} if the artifact was
     *            locally installed.
     * @param contexts The resolution contexts, may be {@code null}.
     */
    public LocalArtifactRegistration(Artifact artifact, RemoteRepository repository, Collection contexts) {
        setArtifact(artifact);
        setRepository(repository);
        setContexts(contexts);
    }

    /**
     * Gets the artifact to register.
     *
     * @return The artifact or {@code null} if not set.
     */
    public Artifact getArtifact() {
        return artifact;
    }

    /**
     * Sets the artifact to register.
     *
     * @param artifact The artifact, may be {@code null}.
     * @return This request for chaining, never {@code null}.
     */
    public LocalArtifactRegistration setArtifact(Artifact artifact) {
        this.artifact = artifact;
        return this;
    }

    /**
     * Gets the remote repository from which the artifact was resolved.
     *
     * @return The remote repository or {@code null} if the artifact was locally installed.
     */
    public RemoteRepository getRepository() {
        return repository;
    }

    /**
     * Sets the remote repository from which the artifact was resolved.
     *
     * @param repository The remote repository or {@code null} if the artifact was locally installed.
     * @return This request for chaining, never {@code null}.
     */
    public LocalArtifactRegistration setRepository(RemoteRepository repository) {
        this.repository = repository;
        return this;
    }

    /**
     * Gets the resolution contexts in which the artifact is available.
     *
     * @return The resolution contexts in which the artifact is available, never {@code null}.
     */
    public Collection getContexts() {
        return contexts;
    }

    /**
     * Sets the resolution contexts in which the artifact is available.
     *
     * @param contexts The resolution contexts, may be {@code null}.
     * @return This request for chaining, never {@code null}.
     */
    public LocalArtifactRegistration setContexts(Collection contexts) {
        if (contexts != null) {
            this.contexts = contexts;
        } else {
            this.contexts = Collections.emptyList();
        }
        return this;
    }
}