Adds User#getMutualGuilds() #252
Conversation
| @@ -243,4 +255,4 @@ public String toString() | |||
| return text; | |||
| } | |||
| } | |||
| } | |||
| } | |||
There was a problem hiding this comment.
pls (re)add a new line char at the end of the file
| @@ -125,6 +129,14 @@ protected void handleResponse(Response response, Request request) | |||
| } | |||
|
|
|||
| @Override | |||
| public Collection<Guild> getMutualGuilds() { | |||
| return getJDA().getGuilds() | |||
| .parallelStream() | |||
There was a problem hiding this comment.
not sure if we should really use a parallel stream here, they can be very slow
| @@ -208,6 +210,24 @@ public boolean equals(Object o) | |||
| User getUserById(String id); | |||
|
|
|||
| /** | |||
| * Gets all {@link Guild}s that contain all given users as their members. | |||
There was a problem hiding this comment.
This has to be a full qualified path to the Guild object like {@link net.dv8tion.jda.core.entities.Guild Guild}
Always include the path and an alias name.
| @@ -208,6 +210,24 @@ public boolean equals(Object o) | |||
| User getUserById(String id); | |||
|
|
|||
| /** | |||
| * Gets all {@link Guild}s that contain all given users as their members. | |||
| * | |||
| * @param users The users which all the returned {@link Guild}s must contain. | |||
There was a problem hiding this comment.
The description of a parameter needs to be aligned in the next line as you can see in the javadoc template.
Same for docs below.
| * | ||
| * @param users The users which all the returned {@link Guild}s must contain. | ||
| * | ||
| * @return Unmodifiable list of all {@link Guild} instances which have all {@link User}s in them. |
There was a problem hiding this comment.
Missing @throws with full qualified name and newline description
Include the plural s in the alias name for the entity that you are linking Users
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.*; |
There was a problem hiding this comment.
This wasn't needed. We only wildcard for 5+ imports from the same package usually.
There was a problem hiding this comment.
Wildcard came from the use of Arrays which set the value to 5, thus it wildcarded.
| Args.notNull(users, "users"); | ||
| for(User u : users) | ||
| { | ||
| if(u == null) |
There was a problem hiding this comment.
This should use Args.notNull, too.
| @@ -125,6 +128,12 @@ protected void handleResponse(Response response, Request request) | |||
| } | |||
|
|
|||
| @Override | |||
| public List<Guild> getMutualGuilds() | |||
There was a problem hiding this comment.
There should also be an option to add other users here, imo
There was a problem hiding this comment.
(This was countered in chat. Decision was not to include it here as it would be redundant to JDA#getMutalGuilds(User...)
| @@ -111,6 +113,14 @@ | |||
| RestAction<PrivateChannel> openPrivateChannel(); | |||
|
|
|||
| /** | |||
| * Finds and collects all {@link net.dv8tion.jda.core.entities.Guild Guild} instances that contain this {@link net.dv8tion.jda.core.entities.User User} within the current {@link net.dv8tion.jda.core.JDA JDA} instance.<br> | |||
There was a problem hiding this comment.
Technically, <br> should be on the next line In this case however, there is no line that is part of this paragraph after this line so there actually shouldn't even be a <br> as the following <p> handles the paragraph separation.
| @@ -111,6 +113,14 @@ | |||
| RestAction<PrivateChannel> openPrivateChannel(); | |||
|
|
|||
| /** | |||
| * Finds and collects all {@link net.dv8tion.jda.core.entities.Guild Guild} instances that contain this {@link net.dv8tion.jda.core.entities.User User} within the current {@link net.dv8tion.jda.core.JDA JDA} instance.<br> | |||
| * <p>This method is a shortcut for {@link net.dv8tion.jda.core.JDA#getMutualGuilds(User...) JDA.getMutualGuilds(User)}.</p> | |||
There was a problem hiding this comment.
Paragraph doesn't need to be closed for future reference.
The start of a new paragraph should be separate from the previous paragraph by an extra line of space in the javadoc comment.
Adds a utility method User#getMutualGuilds() which returns a collection of guilds that are common for the User and its JDA instance.