Package de.jvstvshd.necrify.common.template

Class MinecraftTemplateManager

java.lang.Object

de.jvstvshd.necrify.common.template.MinecraftTemplateManager

All Implemented Interfaces:

TemplateManager

public class MinecraftTemplateManager
extends Object
implements TemplateManager

Constructor Summary

Constructors

Constructor	Description
MinecraftTemplateManager(AbstractNecrifyPlugin plugin, net.kyori.adventure.text.minimessage.MiniMessage miniMessage)

Method Summary

Modifier and Type	Method	Description
@NotNull CompletableFuture<NecrifyTemplate>	createTemplate(String name)	Creates a new template with the given name.
@NotNull Optional<NecrifyTemplate>	getTemplate(String name)	Tries to retrieve a template with the given name.
@NotNull Collection<? extends NecrifyTemplate>	getTemplates()	Returns a list of all currently loaded templates.
@NotNull CompletableFuture<Collection<? extends NecrifyTemplate>>	loadTemplates()	Loads all templates from the storage.
void	removeTemplate(String name)

Methods inherited from class java.lang.Object

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

Constructor Details

MinecraftTemplateManager

public MinecraftTemplateManager(AbstractNecrifyPlugin plugin,
 net.kyori.adventure.text.minimessage.MiniMessage miniMessage)

Method Details

loadTemplates

@NotNull
public @NotNull CompletableFuture<Collection<? extends NecrifyTemplate>> loadTemplates()

Description copied from interface: TemplateManager

Loads all templates from the storage. This action is not meant to get called often and should only be used on start-up.

Specified by:

loadTemplates in interface TemplateManager

Returns:

a CompletableFuture containing all loaded templates or an error

getTemplate

@NotNull
public @NotNull Optional<NecrifyTemplate> getTemplate(String name)

Description copied from interface: TemplateManager

Tries to retrieve a template with the given name.

Specified by:

getTemplate in interface TemplateManager

Parameters:

name - the name of the template

Returns:

an Optional containing the template if it exists

createTemplate

@NotNull
public @NotNull CompletableFuture<NecrifyTemplate> createTemplate(String name)

Description copied from interface: TemplateManager

Creates a new template with the given name. This operation is executed asynchronously and might throw an IllegalArgumentException if the name is invalid or already taken.

Specified by:

createTemplate in interface TemplateManager

Parameters:

name - the name of the template

Returns:

a CompletableFuture containing the created template

getTemplates

@NotNull
public @NotNull Collection<? extends NecrifyTemplate> getTemplates()

Description copied from interface: TemplateManager

Returns a list of all currently loaded templates. If TemplateManager.loadTemplates() has not yet been called, this list will remain empty except newly created templates may be listed.

Specified by:

getTemplates in interface TemplateManager

Returns:

a list of all currently loaded templates

removeTemplate

public void removeTemplate(String name)