org.eclipse.aether.spi.connector

Class MetadataUpload

java.lang.Object

org.eclipse.aether.spi.connector.Transfer

org.eclipse.aether.spi.connector.MetadataTransfer

org.eclipse.aether.spi.connector.MetadataUpload

public final class MetadataUpload
extends MetadataTransfer

An upload of metadata to a remote repository. A repository connector processing this upload has to use setException(MetadataTransferException) to report the results of the transfer.

Constructor Summary

Constructors

Constructor and Description
MetadataUpload() Creates a new uninitialized upload.
MetadataUpload(org.eclipse.aether.metadata.Metadata metadata, File file) Creates a new upload with the specified properties.

Method Summary

Modifier and Type	Method and Description
MetadataUpload	setException(org.eclipse.aether.transfer.MetadataTransferException exception) Sets the exception that occurred during the transfer.
MetadataUpload	setFile(File file) Sets the local file the metadata is downloaded to or uploaded from.
MetadataUpload	setListener(org.eclipse.aether.transfer.TransferListener listener) Sets the listener that is to be notified during the transfer.
MetadataUpload	setMetadata(org.eclipse.aether.metadata.Metadata metadata) Sets the metadata to transfer.
MetadataUpload	setTrace(org.eclipse.aether.RequestTrace trace) Sets the trace information that describes the higher level request/operation in which this transfer is issued.
String	toString()

Methods inherited from class org.eclipse.aether.spi.connector.MetadataTransfer

getException, getFile, getMetadata

Methods inherited from class org.eclipse.aether.spi.connector.Transfer

getListener, getTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MetadataUpload

public MetadataUpload()

Creates a new uninitialized upload.

MetadataUpload

public MetadataUpload(org.eclipse.aether.metadata.Metadata metadata,
                      File file)

Creates a new upload with the specified properties.

Parameters:

metadata - The metadata to upload, may be null.

file - The local file to upload the metadata from, may be null.

Method Detail

setMetadata

public MetadataUpload setMetadata(org.eclipse.aether.metadata.Metadata metadata)

Description copied from class: MetadataTransfer

Sets the metadata to transfer.

Overrides:

setMetadata in class MetadataTransfer

Parameters:

metadata - The metadata, may be null.

Returns:

This transfer for chaining, never null.

setFile

public MetadataUpload setFile(File file)

Description copied from class: MetadataTransfer

Sets the local file the metadata is downloaded to or uploaded from.

Overrides:

setFile in class MetadataTransfer

Parameters:

file - The local file, may be null.

Returns:

This transfer for chaining, never null.

setException

public MetadataUpload setException(org.eclipse.aether.transfer.MetadataTransferException exception)

Description copied from class: MetadataTransfer

Sets the exception that occurred during the transfer.

Overrides:

setException in class MetadataTransfer

Parameters:

exception - The exception, may be null to denote a successful transfer.

Returns:

This transfer for chaining, never null.

setListener

public MetadataUpload setListener(org.eclipse.aether.transfer.TransferListener listener)

Description copied from class: Transfer

Sets the listener that is to be notified during the transfer.

Parameters:

listener - The transfer listener to notify, may be null if none.

Returns:

This transfer for chaining, never null.

setTrace

public MetadataUpload setTrace(org.eclipse.aether.RequestTrace trace)

Description copied from class: Transfer

Sets the trace information that describes the higher level request/operation in which this transfer is issued.

Parameters:

trace - The trace information about the higher level operation, may be null.

Returns:

This transfer for chaining, never null.

toString

public String toString()

Overrides:

toString in class Object