com.bgsoftware.superiorskyblock.api.island.container

Interface IslandsContainer

public interface IslandsContainer

Method Summary

Modifier and Type	Method and Description
void	addIsland(Island island) Add an island to the islands container.
void	addSortingType(SortingType sortingType, boolean sort) Add a new sorting-type.
Island	getIslandAt(org.bukkit.Location location) Get an island at a location.
Island	getIslandAtPosition(int position, SortingType sortingType) Get an island by its position in the top-islands.
Island	getIslandByLeader(java.util.UUID uuid) Get an island by its leader's uuid.
Island	getIslandByUUID(java.util.UUID uuid) Get an island by its uuid.
int	getIslandPosition(Island island, SortingType sortingType) Get the position of an island in the top-islands.
int	getIslandsAmount() Get the amount of islands on the server.
java.util.List<Island>	getIslandsUnsorted() Get all islands.
java.util.List<Island>	getSortedIslands(SortingType sortingType) Get all islands sorted by a specific sorting-type.
void	removeIsland(Island island) Remove an island from the islands container.
void	sortIslands(SortingType sortingType, boolean forceSort, java.lang.Runnable onFinish) Sort islands for the top-islands.
void	sortIslands(SortingType sortingType, java.lang.Runnable onFinish) Sort islands for the top-islands.
void	transferIsland(java.util.UUID oldLeader, java.util.UUID newLeader) Transfer an island from a player to another one.

Method Detail

addIsland

void addIsland(Island island)

Add an island to the islands container.

Parameters:

island - The island to add.

removeIsland

void removeIsland(Island island)

Remove an island from the islands container.

Parameters:

island - The island to remove.

getIslandByUUID

@Nullable
Island getIslandByUUID(java.util.UUID uuid)

Get an island by its uuid.

Parameters:

uuid - The uuid of the island.

getIslandByLeader

@Nullable
Island getIslandByLeader(java.util.UUID uuid)

Get an island by its leader's uuid.

Parameters:

uuid - The uuid of the island's leader.

getIslandAtPosition

@Nullable
Island getIslandAtPosition(int position,
                                      SortingType sortingType)

Get an island by its position in the top-islands.

Parameters:

position - The position of the island.

sortingType - The sorting-type to get islands from.

getIslandPosition

int getIslandPosition(Island island,
                      SortingType sortingType)

Get the position of an island in the top-islands.

Parameters:

island - The island to get position of.

sortingType - The sorting-type to get islands from.

getIslandsAmount

int getIslandsAmount()

Get the amount of islands on the server.

getIslandAt

@Nullable
Island getIslandAt(org.bukkit.Location location)

Get an island at a location.

Parameters:

location - The location to get island in.

transferIsland

void transferIsland(java.util.UUID oldLeader,
                    java.util.UUID newLeader)

Transfer an island from a player to another one. Warning: If you don't know what you're doing, do not use this method. Instead, use Island.transferIsland(SuperiorPlayer).

Parameters:

oldLeader - The uuid of the current leader.

newLeader - The uuid of the new leader.

sortIslands

void sortIslands(SortingType sortingType,
                 @Nullable
                 java.lang.Runnable onFinish)

Sort islands for the top-islands. The islands will not get sorted if only one island exists.

Parameters:

sortingType - The type of sorting to use.

onFinish - Callback method

sortIslands

void sortIslands(SortingType sortingType,
                 boolean forceSort,
                 @Nullable
                 java.lang.Runnable onFinish)

Sort islands for the top-islands.

Parameters:

sortingType - The type of sorting to use.

forceSort - Whether to force-sort the islands. When true, islands will get sorted even if only one island exists.

onFinish - Callback method

getSortedIslands

java.util.List<Island> getSortedIslands(SortingType sortingType)

Get all islands sorted by a specific sorting-type.

Parameters:

sortingType - The type of sorting to use.

getIslandsUnsorted

java.util.List<Island> getIslandsUnsorted()

Get all islands.

addSortingType

void addSortingType(SortingType sortingType,
                    boolean sort)

Add a new sorting-type.

Parameters:

sortingType - The sorting-type to add.

sort - Whether to sort the islands or not when the sorting-type is added.