1
mirror of https://github.com/StarWishsama/Slimefun4.git synced 2024-09-19 19:25:48 +00:00

Javadoc Changes

This commit is contained in:
JustAHuman-xD 2023-02-10 16:45:12 -06:00
parent 33d4741449
commit 2a012cd9c3

View File

@ -61,29 +61,32 @@ public class EnergyNet extends Network implements HologramOwner {
}
/**
* @return An immutable {@link HashMap}
* With a Key of {@link Location} to a Value of {@link EnergyNetProvider}
* Containing all {@link EnergyNetProvider} in the Energy Network
* This creates an Immutable Version of {@link #generators}.
* Using a Key of {@link Location} to a Value of {@link EnergyNetProvider}.
* This Map contains all the {@link EnergyNetProvider} in this Energy Network
* @return {@link HashMap}
*/
public @Nonnull Map<Location, EnergyNetProvider> getGenerators() {
return Collections.unmodifiableMap(generators);
}
/**
* @return An immutable {@link HashMap}
* With a Key of {@link Location} to a Value of {@link EnergyNetProvider}
* Containing all {@link EnergyNetComponent} with the {@link EnergyNetComponentType#CAPACITOR}
* in the Energy Network
* This creates an Immutable Version of {@link #capacitors}.
* Using a Key of {@link Location} to a Value of {@link EnergyNetProvider}.
* This Map contains all the {@link EnergyNetComponent} with the {@link EnergyNetComponentType#CAPACITOR}
* in this Energy Network
* @return {@link Map}
*/
public @Nonnull Map<Location, EnergyNetComponent> getCapacitors() {
return Collections.unmodifiableMap(capacitors);
}
/**
* @return An immutable {@link HashMap}
* With a Key of {@link Location} to a Value of {@link EnergyNetProvider}
* Containing all {@link EnergyNetComponent} with the {@link EnergyNetComponentType#CONSUMER}
* in the Energy Network
* This creates an Immutable Version of {@link #consumers}.
* Using a Key of {@link Location} to a Value of {@link EnergyNetProvider}.
* This Map contains all the {@link EnergyNetComponent} with the {@link EnergyNetComponentType#CONSUMER}
* in this Energy .
* @return {@link Map}
*/
public @Nonnull Map<Location, EnergyNetComponent> getConsumers() {
return Collections.unmodifiableMap(consumers);