io.github.portlek.bukkitlocation

Class LocationUtil

java.lang.Object

io.github.portlek.bukkitlocation.LocationUtil

public final class LocationUtil
extends Object

a class that contains utility methods for Location.

Method Summary

Modifier and Type	Method and Description
static @NotNull org.bukkit.Location	centeredIn(@NotNull org.bukkit.Location location) calculates the center of the given location.
static @NotNull org.bukkit.Location	centeredOn(@NotNull org.bukkit.Location location) calculates the center bottom of the given location.
static @NotNull Optional<org.bukkit.Location>	fromKey(@NotNull String key) converts the given key into a Location.
static @NotNull String	toKey(@NotNull org.bukkit.Location location) converts the given location into a String.
static @NotNull org.bukkit.World	validWorld(@NotNull org.bukkit.Location location) gets the world of the given location.

Methods inherited from class java.lang.Object

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

Method Detail

centeredOn

@NotNull
public static @NotNull org.bukkit.Location centeredOn(@NotNull
                                                               @NotNull org.bukkit.Location location)

calculates the center bottom of the given location.

Parameters:

location - the location to calculate.

Returns:

location of the center from the given location.

centeredIn

@NotNull
public static @NotNull org.bukkit.Location centeredIn(@NotNull
                                                               @NotNull org.bukkit.Location location)

calculates the center of the given location.

Parameters:

location - the location to calculate.

Returns:

location of the center from the given location.

validWorld

@NotNull
public static @NotNull org.bukkit.World validWorld(@NotNull
                                                            @NotNull org.bukkit.Location location)

gets the world of the given location.

Parameters:

location - the location to get.

Returns:

world of the location.

Throws:

IllegalStateException - if the given location has not a world.

fromKey

@NotNull
public static @NotNull Optional<org.bukkit.Location> fromKey(@NotNull
                                                                      @NotNull String key)

converts the given key into a Location.

Parameters:

key - the key to convert.

Returns:

a Location instance.

toKey

@NotNull
public static @NotNull String toKey(@NotNull
                                             @NotNull org.bukkit.Location location)

converts the given location into a String.

Parameters:

location - the location to convert.

Returns:

a String instance.