Package net.guizhanss.guizhanlib.updater

Class GuizhanBuildsUpdater

java.lang.Object

net.guizhanss.guizhanlib.updater.AbstractGuizhanBuildsUpdater

net.guizhanss.guizhanlib.updater.GuizhanBuildsUpdater

public final class GuizhanBuildsUpdater
extends AbstractGuizhanBuildsUpdater

The Guizhan Builds Updater is responsible to auto-update the plugin from Guizhan Builds (builds.guizhanss.com).

Author:

ybw0014

Constructor Summary

Constructors

Constructor	Description
GuizhanBuildsUpdater(Plugin plugin, File file, String user, String repo, String branch)	This constructor sets up the updater.
GuizhanBuildsUpdater(Plugin plugin, File file, String user, String repo, String branch, boolean checkOnly)	Deprecated. in favor of UpdaterConfig.
GuizhanBuildsUpdater(Plugin plugin, File file, String user, String repo, String branch, boolean checkOnly, String lang)	Deprecated. The language option is no longer used, since it is now configured under global config file (/plugins/GuizhanBuildsUpdater/config.yml).
GuizhanBuildsUpdater(Plugin plugin, File file, String user, String repo, String branch, UpdaterConfig updaterConfig)	This constructor sets up the updater.

Method Summary

Modifier and Type	Method	Description
String	getBuildsURL()	Override this method to specify the builds page's URL.
String	getLanguage()	Set the language of updater.
String	getR2URL()	Override this method to specify the R2 bucket URL.

Methods inherited from class net.guizhanss.guizhanlib.updater.AbstractGuizhanBuildsUpdater

getBuildsInfo, getLocalizedString, getRepoKey, getReposFileURL, getTargetUrl, log, log, log, log, start

Methods inherited from class java.lang.Object

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

Constructor Details

GuizhanBuildsUpdater

@ParametersAreNonnullByDefault
public GuizhanBuildsUpdater(Plugin plugin,
 File file,
 String user,
 String repo,
 String branch)

This constructor sets up the updater.

Parameters:

plugin - The Plugin instance

file - The File of plugin

user - GitHub user

repo - GitHub repository

branch - GitHub branch

GuizhanBuildsUpdater

@ParametersAreNonnullByDefault
public GuizhanBuildsUpdater(Plugin plugin,
 File file,
 String user,
 String repo,
 String branch,
 UpdaterConfig updaterConfig)

This constructor sets up the updater.

Parameters:

plugin - The Plugin instance

file - The File of plugin

user - GitHub user

repo - GitHub repository

branch - GitHub branch

updaterConfig - The UpdaterConfig.

GuizhanBuildsUpdater

@Deprecated
@ParametersAreNonnullByDefault
public GuizhanBuildsUpdater(Plugin plugin,
 File file,
 String user,
 String repo,
 String branch,
 boolean checkOnly)

Deprecated.

in favor of UpdaterConfig.

This constructor sets up the updater.

Parameters:

plugin - The Plugin instance

file - The File of plugin

user - GitHub user

repo - GitHub repository

branch - GitHub branch

checkOnly - Whether to check the version only, without downloading

GuizhanBuildsUpdater

@Deprecated
@ParametersAreNonnullByDefault
public GuizhanBuildsUpdater(Plugin plugin,
 File file,
 String user,
 String repo,
 String branch,
 boolean checkOnly,
 String lang)

Deprecated.

The language option is no longer used, since it is now configured under global config file (/plugins/GuizhanBuildsUpdater/config.yml).

This constructor sets up the updater.

Parameters:

plugin - The Plugin instance

file - The File of plugin

user - GitHub user

repo - GitHub repository

branch - GitHub branch

checkOnly - Whether to check the version only, without downloading

lang - The language of updater

Method Details

getBuildsURL

@Nonnull
public String getBuildsURL()

Description copied from class: AbstractGuizhanBuildsUpdater

Override this method to specify the builds page's URL.

No trailing slash is needed.

Example: https://builds.guizhanss.net

Specified by:

getBuildsURL in class AbstractGuizhanBuildsUpdater

Returns:

the URL of builds page

getR2URL

@Nonnull
public String getR2URL()

Description copied from class: AbstractGuizhanBuildsUpdater

Override this method to specify the R2 bucket URL.

No trailing slash is needed.

Example: https://builds-r2.gzassets.net

Specified by:

getR2URL in class AbstractGuizhanBuildsUpdater

Returns:

The R2 bucket URL

getLanguage

@Nonnull
public String getLanguage()

Set the language of updater.

Specified by:

getLanguage in class AbstractGuizhanBuildsUpdater

Returns:

the language of updater