org.eclipse.aether.deployment.DeployResult 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
Show all versions of maven-resolver-api Show documentation
The application programming interface for the repository system.
The newest version!
/*
* 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.deployment;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import org.eclipse.aether.RepositorySystem;
import org.eclipse.aether.artifact.Artifact;
import org.eclipse.aether.metadata.Metadata;
import static java.util.Objects.requireNonNull;
/**
* The result of deploying artifacts and their accompanying metadata into the a remote repository.
*
* @see RepositorySystem#deploy(org.eclipse.aether.RepositorySystemSession, DeployRequest)
*/
public final class DeployResult {
private final DeployRequest request;
private Collection artifacts;
private Collection metadata;
/**
* Creates a new result for the specified request.
*
* @param request The deployment request, must not be {@code null}.
*/
public DeployResult(DeployRequest request) {
this.request = requireNonNull(request, "deploy request cannot be null");
artifacts = Collections.emptyList();
metadata = Collections.emptyList();
}
/**
* Gets the deploy request that was made.
*
* @return The deploy request, never {@code null}.
*/
public DeployRequest getRequest() {
return request;
}
/**
* Gets the artifacts that got deployed.
*
* @return The deployed artifacts, never {@code null}.
*/
public Collection getArtifacts() {
return artifacts;
}
/**
* Sets the artifacts that got deployed.
*
* @param artifacts The deployed artifacts, may be {@code null}.
* @return This result for chaining, never {@code null}.
*/
public DeployResult setArtifacts(Collection artifacts) {
if (artifacts == null) {
this.artifacts = Collections.emptyList();
} else {
this.artifacts = artifacts;
}
return this;
}
/**
* Adds the specified artifacts to the result.
*
* @param artifact The deployed artifact to add, may be {@code null}.
* @return This result for chaining, never {@code null}.
*/
public DeployResult addArtifact(Artifact artifact) {
if (artifact != null) {
if (artifacts.isEmpty()) {
artifacts = new ArrayList<>();
}
artifacts.add(artifact);
}
return this;
}
/**
* Gets the metadata that got deployed. Note that due to automatically generated metadata, there might have been
* more metadata deployed than originally specified in the deploy request.
*
* @return The deployed metadata, never {@code null}.
*/
public Collection getMetadata() {
return metadata;
}
/**
* Sets the metadata that got deployed.
*
* @param metadata The deployed metadata, may be {@code null}.
* @return This result for chaining, never {@code null}.
*/
public DeployResult setMetadata(Collection metadata) {
if (metadata == null) {
this.metadata = Collections.emptyList();
} else {
this.metadata = metadata;
}
return this;
}
/**
* Adds the specified metadata to this result.
*
* @param metadata The deployed metadata to add, may be {@code null}.
* @return This result for chaining, never {@code null}.
*/
public DeployResult addMetadata(Metadata metadata) {
if (metadata != null) {
if (this.metadata.isEmpty()) {
this.metadata = new ArrayList<>();
}
this.metadata.add(metadata);
}
return this;
}
@Override
public String toString() {
return getArtifacts() + ", " + getMetadata();
}
}