Package 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	Description
MetadataUpload()	Creates a new uninitialized upload.
MetadataUpload(Metadata metadata, File file)	Deprecated. Use MetadataUpload(Metadata, Path) instead.
MetadataUpload(Metadata metadata, Path path)	Creates a new upload with the specified properties.

Method Summary

Modifier and Type	Method	Description
MetadataUpload	setException(MetadataTransferException exception)	Sets the exception that occurred during the transfer.
MetadataUpload	setFile(File file)	Deprecated.
MetadataUpload	setListener(TransferListener listener)
MetadataUpload	setMetadata(Metadata metadata)	Sets the metadata to transfer.
MetadataUpload	setPath(Path path)	Sets the local file the metadata is downloaded to or uploaded from.
MetadataUpload	setTrace(RequestTrace trace)
String	toString()

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

getException, getFile, getMetadata, getPath

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 Details

MetadataUpload

public MetadataUpload()

Creates a new uninitialized upload.

MetadataUpload

@Deprecated
public MetadataUpload(Metadata metadata,
 File file)

Deprecated.

Use MetadataUpload(Metadata, Path) instead.

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.

MetadataUpload

public MetadataUpload(Metadata metadata,
 Path path)

Creates a new upload with the specified properties.

Parameters:

metadata - The metadata to upload, may be null.

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

Since:

2.0.0

Method Details

setMetadata

public MetadataUpload setMetadata(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

@Deprecated
public MetadataUpload setFile(File file)

Deprecated.

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.

setPath

public MetadataUpload setPath(Path path)

Description copied from class: MetadataTransfer

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

Overrides:

setPath in class MetadataTransfer

Parameters:

path - The local file, may be null.

Returns:

This transfer for chaining, never null.

setException

public MetadataUpload setException(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(TransferListener listener)

setTrace

public MetadataUpload setTrace(RequestTrace trace)

toString

public String toString()

Overrides:

toString in class Object