Package org.eclipse.aether.impl

Class UpdateCheck<T,E extends RepositoryException>

java.lang.Object
org.eclipse.aether.impl.UpdateCheck<T,E>
Type Parameters:
T -
E -
public final class UpdateCheck<T,E extends RepositoryException> extends Object
A request to check if an update of an artifact/metadata from a remote repository is needed.
See Also:
Provisional:
This type is provisional and can be changed, moved or removed without prior notice.

  • Constructor Details

    • UpdateCheck

      public UpdateCheck()
      Creates an uninitialized update check request.

  • Method Details

    • getLocalLastUpdated

      public long getLocalLastUpdated()
      Gets the last-modified timestamp of the corresponding item produced by a local installation. If non-zero, a remote update will be surpressed if the local item is up-to-date, even if the remote item has not been cached locally.
      Returns:
      The last-modified timestamp of the corresponding item produced by a local installation or 0 to ignore any local item.

    • setLocalLastUpdated

      public UpdateCheck<T,E> setLocalLastUpdated(long localLastUpdated)
      Sets the last-modified timestamp of the corresponding item produced by a local installation. If non-zero, a remote update will be surpressed if the local item is up-to-date, even if the remote item has not been cached locally.
      Parameters:
      localLastUpdated - The last-modified timestamp of the corresponding item produced by a local installation or 0 to ignore any local item.
      Returns:
      This object for chaining.

    • getItem

      public T getItem()
      Gets the item of the check.
      Returns:
      The item of the check, never null.

    • setItem

      public UpdateCheck<T,E> setItem(T item)
      Sets the item of the check.
      Parameters:
      item - The item of the check, must not be null.
      Returns:
      This object for chaining.

    • getFile

      @Deprecated public File getFile()
      Deprecated.
      Use getPath() instead.
      Returns the local file of the item.
      Returns:
      The local file of the item.

    • getPath

      public Path getPath()
      Returns the local file of the item.
      Returns:
      The local file of the item.
      Since:
      2.0.0

    • setFile

      @Deprecated public UpdateCheck<T,E> setFile(File file)
      Deprecated.
      Use setPath(Path) instead.
      Sets the local file of the item.
      Parameters:
      file - The file of the item, never null .
      Returns:
      This object for chaining.

    • setPath

      public UpdateCheck<T,E> setPath(Path path)
      Sets the local file of the item.
      Parameters:
      path - The file of the item, never null .
      Returns:
      This object for chaining.
      Since:
      2.0.0

    • isFileValid

      public boolean isFileValid()
      Indicates whether the local file given by getFile(), if existent, should be considered valid or not. An invalid file is equivalent to a physically missing file.
      Returns:
      true if the file should be considered valid if existent, false if the file should be treated as if it was missing.

    • setFileValid

      public UpdateCheck<T,E> setFileValid(boolean fileValid)
      Controls whether the local file given by getFile(), if existent, should be considered valid or not. An invalid file is equivalent to a physically missing file.
      Parameters:
      fileValid - true if the file should be considered valid if existent, false if the file should be treated as if it was missing.
      Returns:
      This object for chaining.

    • getArtifactPolicy

      public String getArtifactPolicy()
      Gets the policy to use for the artifact check.
      Returns:
      The policy to use for the artifact check.
      Since:
      2.0.0
      See Also:

    • getMetadataPolicy

      public String getMetadataPolicy()
      Gets the policy to use for the metadata check.
      Returns:
      The policy to use for the metadata check.
      Since:
      2.0.0
      See Also:

    • setArtifactPolicy

      public UpdateCheck<T,E> setArtifactPolicy(String artifactPolicy)
      Sets the artifact policy to use for the check.
      Parameters:
      artifactPolicy - The policy to use for the artifact check, may be null.
      Returns:
      This object for chaining.
      Since:
      2.0.0
      See Also:

    • setMetadataPolicy

      public UpdateCheck<T,E> setMetadataPolicy(String metadataPolicy)
      Sets the metadata policy to use for the check.
      Parameters:
      metadataPolicy - The policy to use for the metadata check, may be null.
      Returns:
      This object for chaining.
      Since:
      2.0.0
      See Also:

    • getRepository

      public RemoteRepository getRepository()
      Gets the repository from which a potential update/download will performed.
      Returns:
      The repository to use for the check.

    • setRepository

      public UpdateCheck<T,E> setRepository(RemoteRepository repository)
      Sets the repository from which a potential update/download will performed.
      Parameters:
      repository - The repository to use for the check, must not be null.
      Returns:
      This object for chaining.

    • getAuthoritativeRepository

      public RemoteRepository getAuthoritativeRepository()
      Gets the repository which ultimately hosts the metadata to update. This will be different from the repository given by getRepository() in case the latter denotes a repository manager.
      Returns:
      The actual repository hosting the authoritative copy of the metadata to update, never null for a metadata update check.

    • setAuthoritativeRepository

      public UpdateCheck<T,E> setAuthoritativeRepository(RemoteRepository authoritativeRepository)
      Sets the repository which ultimately hosts the metadata to update. This will be different from the repository given by getRepository() in case the latter denotes a repository manager.
      Parameters:
      authoritativeRepository - The actual repository hosting the authoritative copy of the metadata to update, must not be null for a metadata update check.
      Returns:
      This object for chaining.

    • isRequired

      public boolean isRequired()
      Gets the result of a check, denoting whether the remote repository should be checked for updates.
      Returns:
      The result of a check.

    • setRequired

      public UpdateCheck<T,E> setRequired(boolean required)
      Sets the result of an update check.
      Parameters:
      required - The result of an update check. In case of false and the local file given by getFile() does actually not exist, setException(RepositoryException) should be used to provide the previous/cached failure that explains the absence of the file.
      Returns:
      This object for chaining.

    • getException

      public E getException()
      Gets the exception that occurred during the update check.
      Returns:
      The occurred exception or null if the update check was successful.

    • setException

      public UpdateCheck<T,E> setException(E exception)
      Sets the exception for this update check.
      Parameters:
      exception - The exception for this update check, may be null if the check was successful.
      Returns:
      This object for chaining.

    • toString

      public String toString()
      Overrides:
      toString in class Object