Package xyz.srnyx.annoyingapi.options

Class RegistrationOptions

java.lang.Object

xyz.srnyx.javautilities.parents.Stringable

xyz.srnyx.annoyingapi.options.RegistrationOptions

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

Represents the options for class registration (commands/listeners/etc...)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RegistrationOptions.AutomaticRegistration	The automatic registration options
static class	RegistrationOptions.Selectors

Field Summary

Fields

Modifier and Type	Field	Description
@NotNull RegistrationOptions.AutomaticRegistration	automaticRegistration	The RegistrationOptions.AutomaticRegistration options to automatically register Registrables
@NotNull Supplier<Object>	papiExpansionToRegister	OPTIONAL The PAPI expansion to register when the plugin enables
@NotNull RegistrationOptions.Selectors	selectors
@NotNull Set<Registrable>	toRegister	OPTIONAL The Registrables to register when the plugin enables

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@NotNull RegistrationOptions	automaticRegistration(@NotNull Consumer<RegistrationOptions.AutomaticRegistration> automaticRegistration)	Sets the automaticRegistration using the specified Consumer
@NotNull RegistrationOptions	automaticRegistration(@NotNull RegistrationOptions.AutomaticRegistration automaticRegistration)	Sets the automaticRegistration
@NotNull Optional<me.clip.placeholderapi.expansion.PlaceholderExpansion>	getPapiExpansionToRegister()	Casts the papiExpansionToRegister to a PlaceholderExpansion and returns it
static @NotNull RegistrationOptions	load(@NotNull org.bukkit.configuration.ConfigurationSection section)	Loads the options from the specified ConfigurationSection
@NotNull RegistrationOptions	papiExpansionToRegister(@NotNull Supplier<Object> papiExpansionToRegister)	Sets the papiExpansionToRegister
@NotNull RegistrationOptions	toRegister(@NotNull Collection<Registrable> toRegister)	Adds the specified Registrables to toRegister
final @NotNull RegistrationOptions	toRegister(@NotNull AnnoyingPlugin plugin, @NotNull Class<? extends Registrable>... toRegister)	Adds the specified Registrables to toRegister
@NotNull RegistrationOptions	toRegister(@NotNull AnnoyingPlugin plugin, @NotNull Collection<Class<? extends Registrable>> toRegister)	Adds the specified Registrables to toRegister
@NotNull RegistrationOptions	toRegister(@NotNull Registrable... toRegister)	Adds the specified Registrables to toRegister

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

automaticRegistration

@NotNull
public @NotNull RegistrationOptions.AutomaticRegistration automaticRegistration

The RegistrationOptions.AutomaticRegistration options to automatically register Registrables

selectors

@NotNull
public @NotNull RegistrationOptions.Selectors selectors

toRegister

@NotNull
public @NotNull Set<Registrable> toRegister

OPTIONAL The Registrables to register when the plugin enables

papiExpansionToRegister

@NotNull
public @NotNull Supplier<Object> papiExpansionToRegister

OPTIONAL The PAPI expansion to register when the plugin enables

Can also be a AnnoyingPAPIExpansion

Constructor Details

RegistrationOptions

public RegistrationOptions()

Constructs a new RegistrationOptions instance with default values

Method Details

load

@NotNull
public static @NotNull RegistrationOptions 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

getPapiExpansionToRegister

@NotNull
public @NotNull Optional<me.clip.placeholderapi.expansion.PlaceholderExpansion> getPapiExpansionToRegister()

Casts the papiExpansionToRegister to a PlaceholderExpansion and returns it

Returns:

the papiExpansionToRegister as a PlaceholderExpansion or empty if it isn't

automaticRegistration

@NotNull
public @NotNull RegistrationOptions automaticRegistration(@NotNull
 @NotNull RegistrationOptions.AutomaticRegistration automaticRegistration)

Sets the automaticRegistration

Parameters:

automaticRegistration - the automatic registration

Returns:

this RegistrationOptions instance for chaining

automaticRegistration

@NotNull
public @NotNull RegistrationOptions automaticRegistration(@NotNull
 @NotNull Consumer<RegistrationOptions.AutomaticRegistration> automaticRegistration)

Sets the automaticRegistration using the specified Consumer

Parameters:

automaticRegistration - the automatic registration

Returns:

this RegistrationOptions instance for chaining

toRegister

@NotNull
public @NotNull RegistrationOptions toRegister(@NotNull
 @NotNull Collection<Registrable> toRegister)

Adds the specified Registrables to toRegister

Parameters:

toRegister - the Registrables to add

Returns:

this RegistrationOptions instance for chaining

toRegister

@NotNull
public @NotNull RegistrationOptions toRegister(@NotNull
 @NotNull Registrable... toRegister)

Adds the specified Registrables to toRegister

Parameters:

toRegister - the Registrables to add

Returns:

this RegistrationOptions instance for chaining

toRegister

@NotNull
public @NotNull RegistrationOptions toRegister(@NotNull
 @NotNull AnnoyingPlugin plugin,
 @NotNull
 @NotNull Collection<Class<? extends Registrable>> toRegister)

Adds the specified Registrables to toRegister

Parameters:

plugin - the plugin instance

toRegister - the Registrables to add

Returns:

this RegistrationOptions instance for chaining

toRegister

@NotNull
@SafeVarargs
public final @NotNull RegistrationOptions toRegister(@NotNull
 @NotNull AnnoyingPlugin plugin,
 @NotNull
 @NotNull Class<? extends Registrable>... toRegister)

Adds the specified Registrables to toRegister

Parameters:

plugin - the plugin instance

toRegister - the Registrables to add

Returns:

this RegistrationOptions instance for chaining

papiExpansionToRegister

@NotNull
public @NotNull RegistrationOptions papiExpansionToRegister(@NotNull
 @NotNull Supplier<Object> papiExpansionToRegister)

Sets the papiExpansionToRegister

Parameters:

papiExpansionToRegister - the PAPI expansion to register

Returns:

this RegistrationOptions instance for chaining