Upstream/bentobox
1
0
Fork 0
mirror of https://github.com/BentoBoxWorld/BentoBox.git synced 2024-12-29 04:27:46 +01:00
Code Issues Projects Releases Wiki Activity

Added NonNull/Nullable to FlagsManager; deprecated getFlagById(String)

Browse Source 
Added getFlag(String) that will return an optional instead.
This commit is contained in:
Florian CUNY 2019-01-12 18:03:19 +01:00
parent 12619e79db
commit 76d4edd19f
1 changed files with 28 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
src/main/java/world/bentobox/bentobox/managers/FlagsManager.java
View File

@ -4,10 +4,13 @@ import java.util.ArrayList;
import java.util.HashMap; import java.util.HashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Optional;
import org.bukkit.Bukkit; import org.bukkit.Bukkit;
import org.bukkit.event.Listener; import org.bukkit.event.Listener;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import world.bentobox.bentobox.BentoBox; import world.bentobox.bentobox.BentoBox;
import world.bentobox.bentobox.api.flags.Flag; import world.bentobox.bentobox.api.flags.Flag;
import world.bentobox.bentobox.lists.Flags; import world.bentobox.bentobox.lists.Flags;
@ -19,15 +22,15 @@ import world.bentobox.bentobox.lists.Flags;
public class FlagsManager { public class FlagsManager {
private BentoBox plugin; private BentoBox plugin;
private List<Flag> flags = new ArrayList<>(); private List<@NonNull Flag> flags = new ArrayList<>();
/** /**
* Stores the flag listeners that have already been registered into Bukkit's API to avoid duplicates. * Stores the flag listeners that have already been registered into Bukkit's API to avoid duplicates.
* Value is true if the listener has been registered already * Value is true if the listener has been registered already
*/ */
private Map<Listener, Boolean> registeredListeners = new HashMap<>(); private Map<@NonNull Listener, @NonNull Boolean> registeredListeners = new HashMap<>();
public FlagsManager(BentoBox plugin) { public FlagsManager(@NonNull BentoBox plugin) {
this.plugin = plugin; this.plugin = plugin;
// Register default flags // Register default flags
@ -39,7 +42,10 @@ public class FlagsManager {
* @param flag flag to be registered * @param flag flag to be registered
* @return true if successfully registered, false if not, e.g., because one with the same ID already exists * @return true if successfully registered, false if not, e.g., because one with the same ID already exists
*/ */
public boolean registerFlag(Flag flag) { public boolean registerFlag(@NonNull Flag flag) {
if (flag == null) {
return false;
}
// Check in case the flag id or icon already exists // Check in case the flag id or icon already exists
for (Flag fl : flags) { for (Flag fl : flags) {
if (fl.getID().equals(flag.getID()) || fl.getIcon().equals(flag.getIcon())) { if (fl.getID().equals(flag.getID()) || fl.getIcon().equals(flag.getIcon())) {
@ -64,7 +70,7 @@ public class FlagsManager {
* Tries to register a listener * Tries to register a listener
* @param l - listener * @param l - listener
*/ */
private void registerListener(Listener l) { private void registerListener(@NonNull Listener l) {
registeredListeners.putIfAbsent(l, false); registeredListeners.putIfAbsent(l, false);
if (!registeredListeners.get(l)) { if (!registeredListeners.get(l)) {
Bukkit.getServer().getPluginManager().registerEvents(l, plugin); Bukkit.getServer().getPluginManager().registerEvents(l, plugin);
@ -75,6 +81,7 @@ public class FlagsManager {
/** /**
* @return list of all flags * @return list of all flags
*/ */
@NonNull
public List<Flag> getFlags() { public List<Flag> getFlags() {
return flags; return flags;
} }
@ -83,8 +90,22 @@ public class FlagsManager {
* Get flag by ID * Get flag by ID
* @param id unique id for this flag * @param id unique id for this flag
* @return Flag or null if not known * @return Flag or null if not known
* @deprecated As of 1.1, use {@link #getFlag(String)} instead.
*/ */
public Flag getFlagByID(String id) { @Deprecated
return flags.stream().filter(flag -> flag.getID().equals(id)).findFirst().orElse(null); @Nullable
public Flag getFlagByID(@NonNull String id) {
return getFlag(id).orElse(null);
}
/**
* Gets a Flag by providing an ID.
* @param id Unique ID for this Flag.
* @return Optional containing the Flag instance or empty.
* @since 1.1
*/
@NonNull
public Optional<Flag> getFlag(@NonNull String id) {
return flags.stream().filter(flag -> flag.getID().equals(id)).findFirst();
} }
} }