Package org.mvplugins.multiverse.core.destination

Class DestinationsProvider

java.lang.Object

org.mvplugins.multiverse.core.destination.DestinationsProvider

@Service
public final class DestinationsProvider
extends Object

Provides destinations for teleportation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DestinationsProvider.ParseFailureReason

Method Summary

Modifier and Type	Method	Description
@Nullable Destination<?,?,?>	getDestinationById(@Nullable String identifier)	Gets a destination by its identifier.
@NotNull Collection<Destination<?,?,?>>	getDestinations()	Gets all registered destinations.
@NotNull Attempt<DestinationInstance<?,?>,FailureReason>	parseDestination(@NotNull String destinationString)	Converts a destination string to a destination object.
void	registerDestination(@NotNull Destination<?,?,?> destination)	Adds a destination to the provider.
@NotNull Collection<DestinationSuggestionPacket>	suggestDestinations(@NotNull org.bukkit.command.CommandSender sender, @Nullable String destinationParams)

Methods inherited from class java.lang.Object

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

Method Details

registerDestination

public void registerDestination(@NotNull
 @NotNull Destination<?,?,?> destination)

Adds a destination to the provider.

Parameters:

destination - The destination.

parseDestination

@NotNull
public @NotNull Attempt<DestinationInstance<?,?>,FailureReason> parseDestination(@NotNull
 @NotNull String destinationString)

Converts a destination string to a destination object.

Parameters:

destinationString - The destination string.

Returns:

The destination object, or null if invalid format.

getDestinationById

@Nullable
public @Nullable Destination<?,?,?> getDestinationById(@Nullable
 @Nullable String identifier)

Gets a destination by its identifier.

Parameters:

identifier - The identifier.

Returns:

The destination, or null if not found.

getDestinations

@NotNull
public @NotNull Collection<Destination<?,?,?>> getDestinations()

Gets all registered destinations.

Returns:

A collection of destinations.

suggestDestinations

@NotNull
public @NotNull Collection<DestinationSuggestionPacket> suggestDestinations(@NotNull
 @NotNull org.bukkit.command.CommandSender sender,
 @Nullable
 @Nullable String destinationParams)