| package org.eclipse.aether.spi.connector; |
| |
| /* |
| * 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. |
| */ |
| |
| import java.io.File; |
| |
| import org.eclipse.aether.metadata.Metadata; |
| import org.eclipse.aether.transfer.MetadataTransferException; |
| |
| /** |
| * A download/upload of metadata. |
| * |
| * @noextend This class is not intended to be extended by clients. |
| */ |
| public abstract class MetadataTransfer |
| extends Transfer |
| { |
| |
| private Metadata metadata; |
| |
| private File file; |
| |
| private MetadataTransferException exception; |
| |
| MetadataTransfer() |
| { |
| // hide |
| } |
| |
| /** |
| * Gets the metadata being transferred. |
| * |
| * @return The metadata being transferred or {@code null} if not set. |
| */ |
| public Metadata getMetadata() |
| { |
| return metadata; |
| } |
| |
| /** |
| * Sets the metadata to transfer. |
| * |
| * @param metadata The metadata, may be {@code null}. |
| * @return This transfer for chaining, never {@code null}. |
| */ |
| public MetadataTransfer setMetadata( Metadata metadata ) |
| { |
| this.metadata = metadata; |
| return this; |
| } |
| |
| /** |
| * Gets the local file the metadata is downloaded to or uploaded from. In case of a download, a connector should |
| * first transfer the bytes to a temporary file and only overwrite the target file once the entire download is |
| * completed such that an interrupted/failed download does not corrupt the current file contents. |
| * |
| * @return The local file or {@code null} if not set. |
| */ |
| public File getFile() |
| { |
| return file; |
| } |
| |
| /** |
| * Sets the local file the metadata is downloaded to or uploaded from. |
| * |
| * @param file The local file, may be {@code null}. |
| * @return This transfer for chaining, never {@code null}. |
| */ |
| public MetadataTransfer setFile( File file ) |
| { |
| this.file = file; |
| return this; |
| } |
| |
| /** |
| * Gets the exception that occurred during the transfer (if any). |
| * |
| * @return The exception or {@code null} if the transfer was successful. |
| */ |
| public MetadataTransferException getException() |
| { |
| return exception; |
| } |
| |
| /** |
| * Sets the exception that occurred during the transfer. |
| * |
| * @param exception The exception, may be {@code null} to denote a successful transfer. |
| * @return This transfer for chaining, never {@code null}. |
| */ |
| public MetadataTransfer setException( MetadataTransferException exception ) |
| { |
| this.exception = exception; |
| return this; |
| } |
| |
| } |