Package org.eclipse.aether.spi.connector
Class ArtifactUpload
- java.lang.Object
-
- org.eclipse.aether.spi.connector.Transfer
-
- org.eclipse.aether.spi.connector.ArtifactTransfer
-
- org.eclipse.aether.spi.connector.ArtifactUpload
-
public final class ArtifactUpload extends ArtifactTransfer
An upload of an artifact to a remote repository. A repository connector processing this upload has to usesetException(ArtifactTransferException)
to report the results of the transfer.
-
-
Constructor Summary
Constructors Constructor Description ArtifactUpload()
Creates a new uninitialized upload.ArtifactUpload(org.eclipse.aether.artifact.Artifact artifact, java.io.File file)
Creates a new upload with the specified properties.ArtifactUpload(org.eclipse.aether.artifact.Artifact artifact, java.io.File file, org.eclipse.aether.transform.FileTransformer fileTransformer)
Creates a new upload with the specified properties.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.eclipse.aether.transform.FileTransformer
getFileTransformer()
ArtifactUpload
setArtifact(org.eclipse.aether.artifact.Artifact artifact)
Sets the artifact to transfer.ArtifactUpload
setException(org.eclipse.aether.transfer.ArtifactTransferException exception)
Sets the exception that occurred during the transfer.ArtifactUpload
setFile(java.io.File file)
Sets the local file the artifact is downloaded to or uploaded from.ArtifactUpload
setFileTransformer(org.eclipse.aether.transform.FileTransformer fileTransformer)
ArtifactUpload
setListener(org.eclipse.aether.transfer.TransferListener listener)
ArtifactUpload
setTrace(org.eclipse.aether.RequestTrace trace)
java.lang.String
toString()
-
Methods inherited from class org.eclipse.aether.spi.connector.ArtifactTransfer
getArtifact, getException, getFile
-
Methods inherited from class org.eclipse.aether.spi.connector.Transfer
getListener, getTrace
-
-
-
-
Constructor Detail
-
ArtifactUpload
public ArtifactUpload()
Creates a new uninitialized upload.
-
ArtifactUpload
public ArtifactUpload(org.eclipse.aether.artifact.Artifact artifact, java.io.File file)
Creates a new upload with the specified properties.- Parameters:
artifact
- The artifact to upload, may benull
.file
- The local file to upload the artifact from, may benull
.
-
ArtifactUpload
public ArtifactUpload(org.eclipse.aether.artifact.Artifact artifact, java.io.File file, org.eclipse.aether.transform.FileTransformer fileTransformer)
Creates a new upload with the specified properties.
IMPORTANT When using a fileTransformer, the content of the file is stored in memory to ensure that file content and checksums stay in sync!
- Parameters:
artifact
- The artifact to upload, may benull
.file
- The local file to upload the artifact from, may benull
.fileTransformer
- The file transformer, may benull
.
-
-
Method Detail
-
setArtifact
public ArtifactUpload setArtifact(org.eclipse.aether.artifact.Artifact artifact)
Description copied from class:ArtifactTransfer
Sets the artifact to transfer.- Overrides:
setArtifact
in classArtifactTransfer
- Parameters:
artifact
- The artifact, may benull
.- Returns:
- This transfer for chaining, never
null
.
-
setFile
public ArtifactUpload setFile(java.io.File file)
Description copied from class:ArtifactTransfer
Sets the local file the artifact is downloaded to or uploaded from.- Overrides:
setFile
in classArtifactTransfer
- Parameters:
file
- The local file, may benull
.- Returns:
- This transfer for chaining, never
null
.
-
setException
public ArtifactUpload setException(org.eclipse.aether.transfer.ArtifactTransferException exception)
Description copied from class:ArtifactTransfer
Sets the exception that occurred during the transfer.- Overrides:
setException
in classArtifactTransfer
- Parameters:
exception
- The exception, may benull
to denote a successful transfer.- Returns:
- This transfer for chaining, never
null
.
-
setListener
public ArtifactUpload setListener(org.eclipse.aether.transfer.TransferListener listener)
-
setTrace
public ArtifactUpload setTrace(org.eclipse.aether.RequestTrace trace)
-
setFileTransformer
public ArtifactUpload setFileTransformer(org.eclipse.aether.transform.FileTransformer fileTransformer)
-
getFileTransformer
public org.eclipse.aether.transform.FileTransformer getFileTransformer()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-