API Reference

Core Types

UpdateSource

• String getSourceName()
• UpdateResult checkNow()
• CompletableFuture<UpdateResult> checkNowAsync()

UpdateResult

• boolean isUpdateAvailable()
• String getCurrentVersion()
• Optional<String> getLatestVersion()
• Optional<String> getLatestTag()
• Optional<String> getReleaseUrl()
• Optional<Instant> getPublishedAt()
• Optional<UpdateCheckException> getError()
• boolean hasError()

ChainedUpdateResult

• UpdateResult getResult()
• Optional<String> getSourceUsed()
• Map<String, UpdateCheckException> getFailuresBySource()

Source Checkers

• UpdateChecker (GitHub)
• ModrinthUpdateChecker
• HangarUpdateChecker
• SpigotLegacyUpdateChecker
• CurseForgeUpdateChecker
• MavenMetadataUpdateChecker

All expose builder-based configuration and implement UpdateSource.

Chaining

ChainedUpdateChecker.builder()

• .primary(UpdateSource source)
• .backup(UpdateSource source)
• .addSource(UpdateSource source)
• .build()