Package xyz.srnyx.annoyingapi.options

Class PluginOptions

java.lang.Object

xyz.srnyx.javautilities.parents.Stringable

xyz.srnyx.annoyingapi.options.PluginOptions

public class PluginOptions
extends xyz.srnyx.javautilities.parents.Stringable

Represents the general options for the plugin

Field Summary

Fields

Modifier and Type	Field	Description
@NotNull List<AnnoyingDependency>	dependencies	OPTIONAL The AnnoyingDependencies to check for (add dependencies to this in the plugin's constructor)
@NotNull List<AnnoyingLibrary>	libraries	OPTIONAL The AnnoyingLibraries to load before initializing the plugin This is only needed if you have a library that is required to load before the plugin initializes, otherwise you can just load the library yourself when the plugin enables Loading these libraries will be one of the first (if not the first) things the plugin does
PluginPlatform.Multi	updatePlatforms	RECOMMENDED The different platforms the plugin is available on

Constructor Summary

Constructors

Constructor	Description
PluginOptions()	Constructs a new PluginOptions instance with default values

Method Summary

Modifier and Type	Method	Description
@NotNull PluginOptions	dependencies(@NotNull Collection<AnnoyingDependency> dependencies)	Adds the specified AnnoyingDependencys to dependencies
@NotNull PluginOptions	dependencies(@NotNull AnnoyingDependency... dependencies)	Adds the specified AnnoyingDependencys to dependencies
@NotNull PluginOptions	libraries(@NotNull Collection<AnnoyingLibrary> libraries)	Adds the specified AnnoyingLibrarys to libraries
@NotNull PluginOptions	libraries(@NotNull AnnoyingLibrary... libraries)	Adds the specified AnnoyingLibrarys to libraries
static @NotNull PluginOptions	load(@NotNull org.bukkit.configuration.ConfigurationSection section)	Loads the options from the specified ConfigurationSection
@NotNull PluginOptions	updatePlatforms(@NotNull Collection<PluginPlatform> updatePlatforms)	Sets updatePlatforms
@NotNull PluginOptions	updatePlatforms(@NotNull PluginPlatform... updatePlatforms)	Sets updatePlatforms
@NotNull PluginOptions	updatePlatforms(PluginPlatform.Multi updatePlatforms)	Sets updatePlatforms

Methods inherited from class xyz.srnyx.javautilities.parents.Stringable

toString, toString, toString, toString, toString

Methods inherited from class java.lang.Object

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

Field Details

libraries

@NotNull
public @NotNull List<AnnoyingLibrary> libraries

OPTIONAL The AnnoyingLibraries to load before initializing the plugin
This is only needed if you have a library that is required to load before the plugin initializes, otherwise you can just load the library yourself when the plugin enables
Loading these libraries will be one of the first (if not the first) things the plugin does

dependencies

@NotNull
public @NotNull List<AnnoyingDependency> dependencies

OPTIONAL The AnnoyingDependencies to check for (add dependencies to this in the plugin's constructor)

If you add a dependency to this OUTSIDE the constructor, it will not be checked

This is NOT meant for optional dependencies, all of these dependencies will be downloaded/installed (even if AnnoyingDependency.required is false)

updatePlatforms

@NotNull
public PluginPlatform.Multi updatePlatforms

RECOMMENDED The different platforms the plugin is available on

If not specified, the plugin will not be able to check for updates

Constructor Details

PluginOptions

public PluginOptions()

Constructs a new PluginOptions instance with default values

Method Details

load

@NotNull
public static @NotNull PluginOptions load(@NotNull
 @NotNull org.bukkit.configuration.ConfigurationSection section)

Loads the options from the specified ConfigurationSection

Parameters:

section - the section to load the options from

Returns:

the loaded options

libraries

@NotNull
public @NotNull PluginOptions libraries(@NotNull
 @NotNull Collection<AnnoyingLibrary> libraries)

Adds the specified AnnoyingLibrarys to libraries

Parameters:

libraries - the libraries to add

Returns:

the PluginOptions instance for chaining

libraries

@NotNull
public @NotNull PluginOptions libraries(@NotNull
 @NotNull AnnoyingLibrary... libraries)

Adds the specified AnnoyingLibrarys to libraries

Parameters:

libraries - the libraries to add

Returns:

the PluginOptions instance for chaining

dependencies

@NotNull
public @NotNull PluginOptions dependencies(@NotNull
 @NotNull Collection<AnnoyingDependency> dependencies)

Adds the specified AnnoyingDependencys to dependencies

Parameters:

dependencies - the dependencies to add

Returns:

the PluginOptions instance for chaining

dependencies

@NotNull
public @NotNull PluginOptions dependencies(@NotNull
 @NotNull AnnoyingDependency... dependencies)

Adds the specified AnnoyingDependencys to dependencies

Parameters:

dependencies - the dependencies to add

Returns:

the PluginOptions instance for chaining

updatePlatforms

@NotNull
public @NotNull PluginOptions updatePlatforms(@NotNull
 PluginPlatform.Multi updatePlatforms)

Sets updatePlatforms

Parameters:

updatePlatforms - the new updatePlatforms

Returns:

the PluginOptions instance for chaining

updatePlatforms

@NotNull
public @NotNull PluginOptions updatePlatforms(@NotNull
 @NotNull Collection<PluginPlatform> updatePlatforms)

Sets updatePlatforms

Parameters:

updatePlatforms - the new updatePlatforms

Returns:

the PluginOptions instance for chaining

updatePlatforms

@NotNull
public @NotNull PluginOptions updatePlatforms(@NotNull
 @NotNull PluginPlatform... updatePlatforms)

Sets updatePlatforms

Parameters:

updatePlatforms - the new updatePlatforms

Returns:

the PluginOptions instance for chaining