Package org.eclipse.aether.spi.connector

Class MetadataTransfer

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      org.eclipse.aether.transfer.MetadataTransferException getException()
      Gets the exception that occurred during the transfer (if any).
      java.io.File getFile()
      Deprecated.
      Use getPath() instead.
      org.eclipse.aether.metadata.Metadata getMetadata()
      Gets the metadata being transferred.
      java.nio.file.Path getPath()
      Gets the local file the metadata is downloaded to or uploaded from.
      MetadataTransfer setException​(org.eclipse.aether.transfer.MetadataTransferException exception)
      Sets the exception that occurred during the transfer.
      MetadataTransfer setFile​(java.io.File file)
      Deprecated.
      Use setPath(Path) instead.
      MetadataTransfer setMetadata​(org.eclipse.aether.metadata.Metadata metadata)
      Sets the metadata to transfer.
      MetadataTransfer setPath​(java.nio.file.Path path)
      Sets the local file the metadata is downloaded to or uploaded from.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getMetadata

        public org.eclipse.aether.metadata.Metadata getMetadata()
        Gets the metadata being transferred.
        Returns:
        The metadata being transferred or null if not set.

      • setMetadata

        public MetadataTransfer setMetadata​(org.eclipse.aether.metadata.Metadata metadata)
        Sets the metadata to transfer.
        Parameters:
        metadata - The metadata, may be null.
        Returns:
        This transfer for chaining, never null.

      • getFile

        @Deprecated
public java.io.File getFile()
        Deprecated.
        Use getPath() instead.
        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.
        Returns:
        The local file or null if not set.

      • getPath

        public java.nio.file.Path getPath()
        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.
        Returns:
        The local file or null if not set.
        Since:
        2.0.0

      • setFile

        @Deprecated
public MetadataTransfer setFile​(java.io.File file)
        Deprecated.
        Use setPath(Path) instead.
        Sets the local file the metadata is downloaded to or uploaded from.
        Parameters:
        file - The local file, may be null.
        Returns:
        This transfer for chaining, never null.

      • setPath

        public MetadataTransfer setPath​(java.nio.file.Path path)
        Sets the local file the metadata is downloaded to or uploaded from.
        Parameters:
        path - The local file, may be null.
        Returns:
        This transfer for chaining, never null.
        Since:
        2.0.0

      • getException

        public org.eclipse.aether.transfer.MetadataTransferException getException()
        Gets the exception that occurred during the transfer (if any).
        Specified by:
        getException in class Transfer
        Returns:
        The exception or null if the transfer was successful.

      • setException

        public MetadataTransfer setException​(org.eclipse.aether.transfer.MetadataTransferException exception)
        Sets the exception that occurred during the transfer.
        Parameters:
        exception - The exception, may be null to denote a successful transfer.
        Returns:
        This transfer for chaining, never null.