mirror of
https://github.com/BentoBoxWorld/BentoBox.git
synced 2024-10-31 15:59:48 +01:00
Update JavaDoc to indicate return value is immutable
This commit is contained in:
parent
0f89de6c2a
commit
0de2c3a7b6
@ -24,7 +24,7 @@ public interface Tab {
|
||||
String getName();
|
||||
|
||||
/**
|
||||
* Return the panel items for this tab
|
||||
* Return an immutable list of the panel items for this tab
|
||||
* @return a list of items in slot order
|
||||
*/
|
||||
List<@Nullable PanelItem> getPanelItems();
|
||||
|
@ -479,7 +479,7 @@ public class AddonsManager {
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the list of Addons that are loaded.
|
||||
* Gets an unmodifiable list of Addons that are loaded.
|
||||
* @return list of loaded Addons.
|
||||
* @since 1.1
|
||||
*/
|
||||
@ -489,7 +489,7 @@ public class AddonsManager {
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the list of Addons that are enabled.
|
||||
* Gets an unmodifiable list of Addons that are enabled.
|
||||
* @return list of enabled Addons.
|
||||
* @since 1.1
|
||||
*/
|
||||
@ -645,7 +645,7 @@ public class AddonsManager {
|
||||
}
|
||||
|
||||
/*
|
||||
* Get a list of addon classes that are of type {@link DataObject}
|
||||
* Get a unmodifiable list of addon classes that are of type {@link DataObject}
|
||||
* but not {@link ConfigObject}. Configs are not transitioned to database.
|
||||
* Used in database transition.
|
||||
* @return list of DataObjects
|
||||
|
@ -1674,7 +1674,7 @@ public class IslandsManager {
|
||||
}
|
||||
|
||||
/**
|
||||
* Try to get a list of quarantined islands owned by uuid in this world
|
||||
* Try to get an unmodifiable list of quarantined islands owned by uuid in this world
|
||||
*
|
||||
* @param world - world
|
||||
* @param uuid - target player's UUID, or <tt>null</tt> = unowned islands
|
||||
|
@ -180,7 +180,7 @@ public class Util {
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a list of online players this player can see, i.e. are not invisible
|
||||
* Return an immutable list of online players this player can see, i.e. are not invisible
|
||||
* @param user - the User - if null, all player names on the server are shown
|
||||
* @return a list of online players this player can see
|
||||
*/
|
||||
|
Loading…
Reference in New Issue
Block a user