Package nl.pim16aap2.animatedarchitecture.core.util.updater

Class UpdateChecker

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.util.updater.UpdateChecker

All Implemented Interfaces:

IDebuggable

@Singleton
public final class UpdateChecker
extends Object
implements IDebuggable

Represents an update checker that checks for new releases on GitHub.

Constructor Summary

Constructors

Constructor	Description
UpdateChecker(org.semver4j.Semver currentVersion)	Instantiates a new update checker.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<@Nullable UpdateInformation>	checkForUpdates()	Runs a new update check.
String	getDebugInformation()	Gets the debug information for this object.
@Nullable UpdateInformation	getUpdateInformation()	The most recently retrieve update information.

Methods inherited from class java.lang.Object

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

Constructor Details

UpdateChecker

public UpdateChecker(org.semver4j.Semver currentVersion)

Instantiates a new update checker.

Immediately runs a new check.

Parameters:

currentVersion - The current version of the project to compare potential updates against.

Method Details

checkForUpdates

public CompletableFuture<@Nullable UpdateInformation> checkForUpdates()

Runs a new update check.

Returns:

The resulting update information.

getDebugInformation

public String getDebugInformation()

Description copied from interface: IDebuggable

Gets the debug information for this object.

Specified by:

getDebugInformation in interface IDebuggable

Returns:

The debug information or null if there's nothing to log at this time.

getUpdateInformation

@Nullable
public @Nullable UpdateInformation getUpdateInformation()

The most recently retrieve update information.