de.griefed.versionchecker

Class Update

java.lang.Object

de.griefed.versionchecker.Update

public class Update
extends java.lang.Object

An instance of Update contains information about the release which is considered an update to the version which was used to acquire this Update-instance.
It gives you access to:
- The version.
- The description (release description as shown on release pages on GitLab or GitHub).
- The URL to this release for visiting it in your browser.
- The LocalDate at which this release was published/release.
- A list of ReleaseAsset, if any.
- A list of Source.

Constructor Summary

Constructors

Constructor and Description
Update(@NotNull java.lang.String version, @Nullable java.lang.String description, @NotNull java.net.URL link, @NotNull java.time.LocalDate releaseDate, @Nullable java.util.List<ReleaseAsset> assets, @NotNull java.util.List<Source> sources) Create a new Update-instance.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.util.List<ReleaseAsset>>	assets() Get the ReleaseAsset-list of available assets for this update/release, wrapped in an Optional.
java.util.Optional<java.lang.String>	description() Get the description of this update/release, wrapped in an Optional.
java.util.Optional<ReleaseAsset>	getReleaseAsset(@NotNull java.lang.String releaseName) Get a specific release-asset for a given name of said release.
java.time.LocalDate	releaseDate() Get the LocalDate at which this release was published.
java.util.List<Source>	sources() Get the Source-list of available source-archives for this update/release.
java.util.Optional<Source>	sourceTar() Get the tar-archive-source of this update.
java.util.Optional<Source>	sourceTarBz2() Get the tar.bz2-archive-source of this update.
Source	sourceTarGz() Get the tar.gz-archive-source of this update.
Source	sourceZip() Get the ZIP-archive-source of this update.
java.net.URL	url() Get the URL to this release for use in your browser.
java.lang.String	version() Get the version of this update/release.

Methods inherited from class java.lang.Object

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

Constructor Detail

Update

public Update(@NotNull
              @NotNull java.lang.String version,
              @Nullable
              @Nullable java.lang.String description,
              @NotNull
              @NotNull java.net.URL link,
              @NotNull
              @NotNull java.time.LocalDate releaseDate,
              @Nullable
              @Nullable java.util.List<ReleaseAsset> assets,
              @NotNull
              @NotNull java.util.List<Source> sources)

Create a new Update-instance.

Parameters:

version - String The version of this update/release.

description - String The description (release description as shown on release pages on GitLab or GitHub), of this release/update.

link - URL The URL to this release for visiting it in your browser.

releaseDate - LocalDate The date at which this release was published/release.

assets - ReleaseAsset-list. Available release-assets for this update/release, if any.

sources - Source-list. Available source-archives for this update/release.

Method Detail

version

public java.lang.String version()

Get the version of this update/release.

Returns:

String The version of this update/release.

description

public java.util.Optional<java.lang.String> description()

Get the description of this update/release, wrapped in an Optional.

Returns:

String The description of this update/release, wrapped in an Optional.

url

public java.net.URL url()

Get the URL to this release for use in your browser.

Returns:

URL to this release for use in your browser.

releaseDate

public java.time.LocalDate releaseDate()

Get the LocalDate at which this release was published.

Returns:

LocalDate at which this release was published.

assets

public java.util.Optional<java.util.List<ReleaseAsset>> assets()

Get the ReleaseAsset-list of available assets for this update/release, wrapped in an Optional.

Returns:

ReleaseAsset-list of available assets for this update/release, wrapped in an Optional.

sources

public java.util.List<Source> sources()

Get the Source-list of available source-archives for this update/release.

Returns:

Source-list of available source-archives for this update/release.

sourceZip

public Source sourceZip()

Get the ZIP-archive-source of this update.

Returns:

Source of ArchiveType.ZIP of this update.

sourceTarGz

public Source sourceTarGz()

Get the tar.gz-archive-source of this update.

Returns:

Source of ArchiveType.TAR_GZ of this update.

sourceTar

public java.util.Optional<Source> sourceTar()

Get the tar-archive-source of this update. A tar-archive is usually only available for GitLab updates. GitHub typically only provides zip- and tar.gz-archives.

Returns:

Source of ArchiveType.TAR of this update, wrapped in an Optional.

sourceTarBz2

public java.util.Optional<Source> sourceTarBz2()

Get the tar.bz2-archive-source of this update. A tar.bz2-archive is usually only available for GitLab updates. GitHub typically only provides zip- and tar.gz-archives.

Returns:

Source of ArchiveType.TAR_BZ2 of this update, wrapped in an Optional.

getReleaseAsset

public java.util.Optional<ReleaseAsset> getReleaseAsset(@NotNull
                                                        @NotNull java.lang.String releaseName)

Get a specific release-asset for a given name of said release.

Parameters:

releaseName - String The name of the release asset.

Returns:

ReleaseAsset for the given name, wrapped in an Optional.