Package xyz.srnyx.annoyingapi

Class PluginPlatform

java.lang.Object

xyz.srnyx.javautilities.parents.Stringable

xyz.srnyx.annoyingapi.PluginPlatform

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

Contains information about a plugin on a PluginPlatform.Platform

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PluginPlatform.Multi	A collection of PluginPlatforms
static enum	PluginPlatform.Platform	Platforms that plugins can be downloaded (or checked for updates) from

Field Summary

Fields

Modifier and Type	Field	Description
@Nullable String	author	The author of the plugin (only required for PluginPlatform.Platform.HANGAR)
final @NotNull String	identifier	The identifier of the plugin on the platform
final @NotNull PluginPlatform.Platform	platform	The platform the plugin is on

Constructor Summary

Constructors

Constructor	Description
PluginPlatform(@NotNull PluginPlatform.Platform platform, @NotNull String identifier)	Creates a new PluginPlatform
PluginPlatform(@NotNull PluginPlatform.Platform platform, @NotNull String identifier, @Nullable String author)	Creates a new PluginPlatform

Method Summary

Modifier and Type	Method	Description
static @NotNull PluginPlatform	bukkit(@NotNull String identifier)	Creates a new PluginPlatform for PluginPlatform.Platform.BUKKIT
static @NotNull PluginPlatform	external(@NotNull String identifier)	Creates a new PluginPlatform for PluginPlatform.Platform.EXTERNAL
static @NotNull PluginPlatform	hangar(@NotNull String identifier, @NotNull String author)	Creates a new PluginPlatform for PluginPlatform.Platform.HANGAR
static @NotNull PluginPlatform	hangar(@NotNull String identifier, @NotNull org.bukkit.plugin.Plugin plugin)	Creates a new PluginPlatform for PluginPlatform.Platform.HANGAR
static @NotNull PluginPlatform	hangar(@NotNull org.bukkit.plugin.Plugin plugin)	Creates a new PluginPlatform for PluginPlatform.Platform.HANGAR
static @NotNull PluginPlatform	hangar(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull String author)	Creates a new PluginPlatform for PluginPlatform.Platform.HANGAR
static @NotNull Optional<PluginPlatform>	load(@NotNull org.bukkit.configuration.ConfigurationSection section)	Loads a PluginPlatform from a ConfigurationSection
static @NotNull PluginPlatform	manual(@NotNull String identifier)	Creates a new PluginPlatform for PluginPlatform.Platform.MANUAL
static @NotNull PluginPlatform	modrinth(@NotNull String identifier)	Creates a new PluginPlatform for PluginPlatform.Platform.MODRINTH
static @NotNull PluginPlatform	spigot(@NotNull String identifier)	Creates a new PluginPlatform for PluginPlatform.Platform.SPIGOT

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

platform

@NotNull
public final @NotNull PluginPlatform.Platform platform

The platform the plugin is on

identifier

@NotNull
public final @NotNull String identifier

The identifier of the plugin on the platform

author

@Nullable
public @Nullable String author

The author of the plugin (only required for PluginPlatform.Platform.HANGAR)

Constructor Details

PluginPlatform

public PluginPlatform(@NotNull
 @NotNull PluginPlatform.Platform platform,
 @NotNull
 @NotNull String identifier)

Creates a new PluginPlatform

Parameters:

platform - platform

identifier - identifier

PluginPlatform

public PluginPlatform(@NotNull
 @NotNull PluginPlatform.Platform platform,
 @NotNull
 @NotNull String identifier,
 @Nullable
 @Nullable String author)

Creates a new PluginPlatform

Parameters:

platform - platform

identifier - identifier

author - author

Method Details

load

@NotNull
public static @NotNull Optional<PluginPlatform> load(@NotNull
 @NotNull org.bukkit.configuration.ConfigurationSection section)

Loads a PluginPlatform from a ConfigurationSection

Parameters:

section - the section to load from

Returns:

the loaded PluginPlatform

modrinth

@NotNull
public static @NotNull PluginPlatform modrinth(@NotNull
 @NotNull String identifier)

Creates a new PluginPlatform for PluginPlatform.Platform.MODRINTH

Parameters:

identifier - identifier

Returns:

a new PluginPlatform

hangar

@NotNull
public static @NotNull PluginPlatform hangar(@NotNull
 @NotNull String identifier,
 @NotNull
 @NotNull String author)

Creates a new PluginPlatform for PluginPlatform.Platform.HANGAR

Parameters:

identifier - identifier

author - author

Returns:

a new PluginPlatform

hangar

@NotNull
public static @NotNull PluginPlatform hangar(@NotNull
 @NotNull String identifier,
 @NotNull
 @NotNull org.bukkit.plugin.Plugin plugin)
                                      throws IllegalArgumentException

Creates a new PluginPlatform for PluginPlatform.Platform.HANGAR

Parameters:

identifier - identifier

plugin - the plugin to get the author from

Returns:

a new PluginPlatform

Throws:

IllegalArgumentException - if the plugin has no authors

hangar

@NotNull
public static @NotNull PluginPlatform hangar(@NotNull
 @NotNull org.bukkit.plugin.Plugin plugin,
 @NotNull
 @NotNull String author)

Creates a new PluginPlatform for PluginPlatform.Platform.HANGAR

Parameters:

plugin - the plugin to get the identifier from

author - author

Returns:

a new PluginPlatform

hangar

@NotNull
public static @NotNull PluginPlatform hangar(@NotNull
 @NotNull org.bukkit.plugin.Plugin plugin)
                                      throws IllegalArgumentException

Creates a new PluginPlatform for PluginPlatform.Platform.HANGAR

Parameters:

plugin - the plugin to get the identifier and author from

Returns:

a new PluginPlatform

Throws:

IllegalArgumentException - if the plugin has no authors

spigot

@NotNull
public static @NotNull PluginPlatform spigot(@NotNull
 @NotNull String identifier)

Creates a new PluginPlatform for PluginPlatform.Platform.SPIGOT

Parameters:

identifier - identifier

Returns:

a new PluginPlatform

bukkit

@NotNull
public static @NotNull PluginPlatform bukkit(@NotNull
 @NotNull String identifier)

Creates a new PluginPlatform for PluginPlatform.Platform.BUKKIT

Parameters:

identifier - identifier

Returns:

a new PluginPlatform

external

@NotNull
public static @NotNull PluginPlatform external(@NotNull
 @NotNull String identifier)

Creates a new PluginPlatform for PluginPlatform.Platform.EXTERNAL

Parameters:

identifier - identifier

Returns:

a new PluginPlatform

manual

@NotNull
public static @NotNull PluginPlatform manual(@NotNull
 @NotNull String identifier)

Creates a new PluginPlatform for PluginPlatform.Platform.MANUAL

Parameters:

identifier - identifier

Returns:

a new PluginPlatform