Skip to content

Commit e488032

Browse files
committed
Add missing javadocs
1 parent bed8e18 commit e488032

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

common/src/main/java/io/github/communityradargg/forgemod/util/VersionBridge.java

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,67 @@
55
import java.util.Set;
66
import java.util.UUID;
77

8+
/**
9+
* An interface holding all methods, which need a version specific implementation.
10+
*/
811
public interface VersionBridge {
12+
/**
13+
* Gets the mod version.
14+
*
15+
* @return Returns the mod version.
16+
*/
917
@NotNull String getVersion();
1018

19+
/**
20+
* Adds a message to the player chat.
21+
*
22+
* @param message The message.
23+
*/
1124
void addMessageToChat(final @NotNull String message);
1225

26+
/**
27+
* Checks if the player is not in a world.
28+
*
29+
* @return Returns {@code true} if the player is not in a world, else {@code false}.
30+
*/
1331
boolean isNotInWorld();
1432

33+
/**
34+
* Gets a list with player wrappers with their game profile UUID and name for all players in the current world.
35+
*
36+
* @return Returns the list with player wrappers with all players in the world.
37+
*/
1538
@NotNull List<@NotNull PlayerInfo> getWorldPlayers();
1639

40+
/**
41+
* Updates a player by its UUID.
42+
*
43+
* @param commonHandler The common handler.
44+
* @param uuid The player UUID.
45+
* @param oldPrefixes A Set with old prefixes.
46+
*/
1747
void updatePlayerByUuid(final @NotNull CommonHandler commonHandler, final @NotNull UUID uuid, final @NotNull Set<@NotNull String> oldPrefixes);
1848

49+
/**
50+
* Updates the prefixes for all players.
51+
*
52+
* @param commonHandler The common handler.
53+
* @param oldPrefixes A Set with old prefixes.
54+
*/
1955
void updatePrefixes(final @NotNull CommonHandler commonHandler, final @NotNull Set<String> oldPrefixes);
2056

57+
/**
58+
* Checks is the player list key is pressed.
59+
*
60+
* @return Returns {@code true} if the key is pressed, else {@code false}.
61+
*/
2162
boolean isPlayerListKeyPressed();
2263

64+
/**
65+
* Wraps a given text in the version specific text component and unformat it for later possible comparison.
66+
*
67+
* @param text The text.
68+
* @return Returns the unformatted text.
69+
*/
2370
@NotNull String wrapAndUnformatText(final @NotNull String text);
2471
}

0 commit comments

Comments
 (0)