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.StringableContains information about a plugin on aPluginPlatform.Platform
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPluginPlatform.MultiA collection ofPluginPlatformsstatic classPluginPlatform.PlatformPlatforms that plugins can be downloaded (or checked for updates) from
-
Field Summary
Fields Modifier and Type Field Description @Nullable java.lang.StringauthorThe author of the plugin (only required forPluginPlatform.Platform.HANGAR)@NotNull java.lang.StringidentifierThe identifier of the plugin on the platform@NotNull PluginPlatform.PlatformplatformThe platform the plugin is on
-
Constructor Summary
Constructors Constructor Description PluginPlatform(@NotNull PluginPlatform.Platform platform, @NotNull java.lang.String identifier)Creates a newPluginPlatformPluginPlatform(@NotNull PluginPlatform.Platform platform, @NotNull java.lang.String identifier, @Nullable java.lang.String author)Creates a newPluginPlatform
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static @NotNull PluginPlatformbukkit(@NotNull java.lang.String identifier)Creates a newPluginPlatformforPluginPlatform.Platform.BUKKITstatic @NotNull PluginPlatformexternal(@NotNull java.lang.String identifier)Creates a newPluginPlatformforPluginPlatform.Platform.EXTERNALstatic @NotNull PluginPlatformhangar(@NotNull java.lang.String identifier, @NotNull java.lang.String author)Creates a newPluginPlatformforPluginPlatform.Platform.HANGARstatic @NotNull PluginPlatformhangar(@NotNull java.lang.String identifier, @NotNull org.bukkit.plugin.Plugin plugin)Creates a newPluginPlatformforPluginPlatform.Platform.HANGARstatic @NotNull PluginPlatformhangar(@NotNull org.bukkit.plugin.Plugin plugin)Creates a newPluginPlatformforPluginPlatform.Platform.HANGARstatic @NotNull PluginPlatformhangar(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.lang.String author)Creates a newPluginPlatformforPluginPlatform.Platform.HANGARstatic @NotNull java.util.Optional<PluginPlatform>load(@NotNull org.bukkit.configuration.ConfigurationSection section)Loads aPluginPlatformfrom aConfigurationSectionstatic @NotNull PluginPlatformmanual(@NotNull java.lang.String identifier)Creates a newPluginPlatformforPluginPlatform.Platform.MANUALstatic @NotNull PluginPlatformmodrinth(@NotNull java.lang.String identifier)Creates a newPluginPlatformforPluginPlatform.Platform.MODRINTHstatic @NotNull PluginPlatformspigot(@NotNull java.lang.String identifier)Creates a newPluginPlatformforPluginPlatform.Platform.SPIGOT
-
-
-
Field Detail
-
platform
@NotNull public final @NotNull PluginPlatform.Platform platform
The platform the plugin is on
-
identifier
@NotNull public final @NotNull java.lang.String identifier
The identifier of the plugin on the platform
-
author
@Nullable public @Nullable java.lang.String author
The author of the plugin (only required forPluginPlatform.Platform.HANGAR)
-
-
Constructor Detail
-
PluginPlatform
public PluginPlatform(@NotNull @NotNull PluginPlatform.Platform platform, @NotNull @NotNull java.lang.String identifier)Creates a newPluginPlatform- Parameters:
platform-platformidentifier-identifier
-
PluginPlatform
public PluginPlatform(@NotNull @NotNull PluginPlatform.Platform platform, @NotNull @NotNull java.lang.String identifier, @Nullable @Nullable java.lang.String author)Creates a newPluginPlatform- Parameters:
platform-platformidentifier-identifierauthor-author
-
-
Method Detail
-
load
@NotNull public static @NotNull java.util.Optional<PluginPlatform> load(@NotNull @NotNull org.bukkit.configuration.ConfigurationSection section)
Loads aPluginPlatformfrom aConfigurationSection- Parameters:
section- the section to load from- Returns:
- the loaded
PluginPlatform
-
modrinth
@NotNull public static @NotNull PluginPlatform modrinth(@NotNull @NotNull java.lang.String identifier)
Creates a newPluginPlatformforPluginPlatform.Platform.MODRINTH- Parameters:
identifier-identifier- Returns:
- a new
PluginPlatform
-
hangar
@NotNull public static @NotNull PluginPlatform hangar(@NotNull @NotNull java.lang.String identifier, @NotNull @NotNull java.lang.String author)
Creates a newPluginPlatformforPluginPlatform.Platform.HANGAR- Parameters:
identifier-identifierauthor-author- Returns:
- a new
PluginPlatform
-
hangar
@NotNull public static @NotNull PluginPlatform hangar(@NotNull @NotNull java.lang.String identifier, @NotNull @NotNull org.bukkit.plugin.Plugin plugin) throws java.lang.IllegalArgumentException
Creates a newPluginPlatformforPluginPlatform.Platform.HANGAR- Parameters:
identifier-identifierplugin- the plugin to get theauthorfrom- Returns:
- a new
PluginPlatform - Throws:
java.lang.IllegalArgumentException- if the plugin has no authors
-
hangar
@NotNull public static @NotNull PluginPlatform hangar(@NotNull @NotNull org.bukkit.plugin.Plugin plugin, @NotNull @NotNull java.lang.String author)
Creates a newPluginPlatformforPluginPlatform.Platform.HANGAR- Parameters:
plugin- the plugin to get theidentifierfromauthor-author- Returns:
- a new
PluginPlatform
-
hangar
@NotNull public static @NotNull PluginPlatform hangar(@NotNull @NotNull org.bukkit.plugin.Plugin plugin) throws java.lang.IllegalArgumentException
Creates a newPluginPlatformforPluginPlatform.Platform.HANGAR- Parameters:
plugin- the plugin to get theidentifierandauthorfrom- Returns:
- a new
PluginPlatform - Throws:
java.lang.IllegalArgumentException- if the plugin has no authors
-
spigot
@NotNull public static @NotNull PluginPlatform spigot(@NotNull @NotNull java.lang.String identifier)
Creates a newPluginPlatformforPluginPlatform.Platform.SPIGOT- Parameters:
identifier-identifier- Returns:
- a new
PluginPlatform
-
bukkit
@NotNull public static @NotNull PluginPlatform bukkit(@NotNull @NotNull java.lang.String identifier)
Creates a newPluginPlatformforPluginPlatform.Platform.BUKKIT- Parameters:
identifier-identifier- Returns:
- a new
PluginPlatform
-
external
@NotNull public static @NotNull PluginPlatform external(@NotNull @NotNull java.lang.String identifier)
Creates a newPluginPlatformforPluginPlatform.Platform.EXTERNAL- Parameters:
identifier-identifier- Returns:
- a new
PluginPlatform
-
manual
@NotNull public static @NotNull PluginPlatform manual(@NotNull @NotNull java.lang.String identifier)
Creates a newPluginPlatformforPluginPlatform.Platform.MANUAL- Parameters:
identifier-identifier- Returns:
- a new
PluginPlatform
-
-