Add support for forum channels

src/main/java/net/dv8tion/jda/api/entities/Category.java

@@ -17,6 +17,7 @@
 package net.dv8tion.jda.api.entities;
 
 import net.dv8tion.jda.api.JDA;
+import net.dv8tion.jda.api.entities.channel.concrete.ForumChannel;
 import net.dv8tion.jda.api.managers.channel.concrete.CategoryManager;
 import net.dv8tion.jda.api.requests.restaction.ChannelAction;
 import net.dv8tion.jda.api.requests.restaction.order.CategoryOrderAction;
@@ -49,10 +50,8 @@
 public interface Category extends GuildChannel, ICopyableChannel, IPositionableChannel, IPermissionContainer, IMemberContainer
 {
     /**
-     * All {@link GuildChannel Channels} listed
-     * for this Category
-     * <br>This may contain {@link net.dv8tion.jda.api.entities.VoiceChannel VoiceChannels},
-     * and {@link net.dv8tion.jda.api.entities.TextChannel TextChannels}!
+     * All {@link GuildChannel Channels} listed for this Category.
+     * <br>Includes all types of channels, except for threads.
      *
      * @return Immutable list of all child channels
      */
@@ -64,6 +63,7 @@ default List<GuildChannel> getChannels()
         channels.addAll(getVoiceChannels());
         channels.addAll(getStageChannels());
         channels.addAll(getNewsChannels());
+        channels.addAll(getForumChannels());
         Collections.sort(channels);
 
         return Collections.unmodifiableList(channels);
@@ -78,9 +78,11 @@ default List<GuildChannel> getChannels()
     @Nonnull
     default List<TextChannel> getTextChannels()
     {
-        return Collections.unmodifiableList(getGuild().getTextChannelCache().stream()
-            .filter(channel -> equals(channel.getParentCategory()))
-            .sorted().collect(Collectors.toList()));
+        return Collections.unmodifiableList(getGuild().getTextChannelCache().applyStream(stream ->
+            stream.filter(channel -> equals(channel.getParentCategory()))
+                  .sorted()
+                  .collect(Collectors.toList())
+        ));
     }
 
     /**
@@ -92,9 +94,26 @@ default List<TextChannel> getTextChannels()
     @Nonnull
     default List<NewsChannel> getNewsChannels()
     {
-        return Collections.unmodifiableList(getGuild().getNewsChannelCache().stream()
-            .filter(channel -> equals(channel.getParentCategory()))
-            .sorted().collect(Collectors.toList()));
+        return Collections.unmodifiableList(getGuild().getNewsChannelCache().applyStream(stream ->
+            stream.filter(channel -> equals(channel.getParentCategory()))
+                  .sorted()
+                  .collect(Collectors.toList())
+        ));
+    }
+
+    /**
+     * All {@link net.dv8tion.jda.api.entities.channel.concrete.ForumChannel ForumChannels} listed for this Category
+     *
+     * @return Immutable list of all child ForumChannels
+     */
+    @Nonnull
+    default List<ForumChannel> getForumChannels()
+    {
+        return Collections.unmodifiableList(getGuild().getForumChannelCache().applyStream(stream ->
+            stream.filter(channel -> equals(channel.getParentCategory()))
+                  .sorted()
+                  .collect(Collectors.toList())
+        ));
     }
 
     /**
@@ -106,9 +125,11 @@ default List<NewsChannel> getNewsChannels()
     @Nonnull
     default List<VoiceChannel> getVoiceChannels()
     {
-        return Collections.unmodifiableList(getGuild().getVoiceChannelCache().stream()
-            .filter(channel -> equals(channel.getParentCategory()))
-            .sorted().collect(Collectors.toList()));
+        return Collections.unmodifiableList(getGuild().getVoiceChannelCache().applyStream(stream ->
+            stream.filter(channel -> equals(channel.getParentCategory()))
+                  .sorted()
+                  .collect(Collectors.toList())
+        ));
     }
 
     /**
@@ -120,9 +141,11 @@ default List<VoiceChannel> getVoiceChannels()
     @Nonnull
     default List<StageChannel> getStageChannels()
     {
-        return Collections.unmodifiableList(getGuild().getStageChannelCache().stream()
-            .filter(channel -> equals(channel.getParentCategory()))
-            .sorted().collect(Collectors.toList()));
+        return Collections.unmodifiableList(getGuild().getStageChannelCache().applyStream(stream ->
+            stream.filter(channel -> equals(channel.getParentCategory()))
+                  .sorted()
+                  .collect(Collectors.toList())
+        ));
     }
 
     /**
@@ -148,12 +171,12 @@ default List<StageChannel> getStageChannels()
      * </ul>
      *
      * @param  name
-     *         The name of the TextChannel to create
+     *         The name of the TextChannel to create (up to {@value Channel#MAX_NAME_LENGTH} characters)
      *
      * @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
      *         If the logged in account does not have the {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL} permission
      * @throws IllegalArgumentException
-     *         If the provided name is {@code null} or empty or greater than 100 characters in length
+     *         If the provided name is {@code null}, empty, or longer than {@value Channel#MAX_NAME_LENGTH} characters
      *
      * @return A specific {@link ChannelAction ChannelAction}
      *         <br>This action allows to set fields for the new TextChannel before creating it
@@ -162,6 +185,43 @@ default List<StageChannel> getStageChannels()
     @CheckReturnValue
     ChannelAction<TextChannel> createTextChannel(@Nonnull String name);
 
+    /**
+     * Creates a new {@link net.dv8tion.jda.api.entities.NewsChannel NewsChannel} with this Category as parent.
+     * For this to be successful, the logged in account has to have the
+     * {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL MANAGE_CHANNEL} Permission in this Category.
+     *
+     * <p>This will copy all {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverrides} of this Category!
+     * Unless the bot is unable to sync it with this category due to permission escalation.
+     * See {@link IPermissionHolder#canSync(IPermissionContainer, IPermissionContainer)} for details.
+     *
+     * <p>Possible {@link net.dv8tion.jda.api.requests.ErrorResponse ErrorResponses} caused by
+     * the returned {@link net.dv8tion.jda.api.requests.RestAction RestAction} include the following:
+     * <ul>
+     *     <li>{@link net.dv8tion.jda.api.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
+     *     <br>The channel could not be created due to a permission discrepancy</li>
+     *
+     *     <li>{@link net.dv8tion.jda.api.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
+     *     <br>The {@link net.dv8tion.jda.api.Permission#VIEW_CHANNEL VIEW_CHANNEL} permission was removed</li>
+     *
+     *     <li>{@link net.dv8tion.jda.api.requests.ErrorResponse#MAX_CHANNELS MAX_CHANNELS}
+     *     <br>The maximum number of channels were exceeded</li>
+     * </ul>
+     *
+     * @param  name
+     *         The name of the NewsChannel to create (up to {@value Channel#MAX_NAME_LENGTH} characters)
+     *
+     * @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
+     *         If the logged in account does not have the {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL} permission
+     * @throws IllegalArgumentException
+     *         If the provided name is {@code null}, empty, or longer than {@value Channel#MAX_NAME_LENGTH} characters
+     *
+     * @return A specific {@link ChannelAction ChannelAction}
+     *         <br>This action allows to set fields for the new NewsChannel before creating it
+     */
+    @Nonnull
+    @CheckReturnValue
+    ChannelAction<NewsChannel> createNewsChannel(@Nonnull String name);
+
     /**
      * Creates a new {@link net.dv8tion.jda.api.entities.VoiceChannel VoiceChannel} with this Category as parent.
      * For this to be successful, the logged in account has to have the
@@ -185,12 +245,12 @@ default List<StageChannel> getStageChannels()
      * </ul>
      *
      * @param  name
-     *         The name of the VoiceChannel to create
+     *         The name of the VoiceChannel to create (up to {@value Channel#MAX_NAME_LENGTH} characters)
      *
      * @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
      *         If the logged in account does not have the {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL} permission
      * @throws IllegalArgumentException
-     *         If the provided name is {@code null} or empty or greater than 100 characters in length
+     *         If the provided name is {@code null}, empty, or longer than {@value Channel#MAX_NAME_LENGTH} characters
      *
      * @return A specific {@link ChannelAction ChannelAction}
      *         <br>This action allows to set fields for the new VoiceChannel before creating it
@@ -222,12 +282,12 @@ default List<StageChannel> getStageChannels()
      * </ul>
      *
      * @param  name
-     *         The name of the StageChannel to create
+     *         The name of the StageChannel to create (up to {@value Channel#MAX_NAME_LENGTH} characters)
      *
      * @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
      *         If the logged in account does not have the {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL} permission
      * @throws IllegalArgumentException
-     *         If the provided name is {@code null} or empty or greater than 100 characters in length
+     *         If the provided name is {@code null}, empty, or longer than {@value Channel#MAX_NAME_LENGTH} characters
      *
      * @return A specific {@link ChannelAction ChannelAction}
      *         <br>This action allows to set fields for the new StageChannel before creating it
@@ -236,6 +296,43 @@ default List<StageChannel> getStageChannels()
     @CheckReturnValue
     ChannelAction<StageChannel> createStageChannel(@Nonnull String name);
 
+    /**
+     * Creates a new {@link ForumChannel} with this Category as parent.
+     * For this to be successful, the logged in account has to have the
+     * {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL MANAGE_CHANNEL} Permission in this Category.
+     *
+     * <p>This will copy all {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverrides} of this Category!
+     * Unless the bot is unable to sync it with this category due to permission escalation.
+     * See {@link IPermissionHolder#canSync(IPermissionContainer, IPermissionContainer)} for details.
+     *
+     * <p>Possible {@link net.dv8tion.jda.api.requests.ErrorResponse ErrorResponses} caused by
+     * the returned {@link net.dv8tion.jda.api.requests.RestAction RestAction} include the following:
+     * <ul>
+     *     <li>{@link net.dv8tion.jda.api.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
+     *     <br>The channel could not be created due to a permission discrepancy</li>
+     *
+     *     <li>{@link net.dv8tion.jda.api.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
+     *     <br>The {@link net.dv8tion.jda.api.Permission#VIEW_CHANNEL VIEW_CHANNEL} permission was removed</li>
+     *
+     *     <li>{@link net.dv8tion.jda.api.requests.ErrorResponse#MAX_CHANNELS MAX_CHANNELS}
+     *     <br>The maximum number of channels were exceeded</li>
+     * </ul>
+     *
+     * @param  name
+     *         The name of the ForumChannel to create (up to {@value Channel#MAX_NAME_LENGTH} characters)
+     *
+     * @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
+     *         If the logged in account does not have the {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL} permission
+     * @throws IllegalArgumentException
+     *         If the provided name is {@code null}, empty, or longer than {@value Channel#MAX_NAME_LENGTH} characters
+     *
+     * @return A specific {@link ChannelAction ChannelAction}
+     *         <br>This action allows to set fields for the new ForumChannel before creating it
+     */
+    @Nonnull
+    @CheckReturnValue
+    ChannelAction<ForumChannel> createForumChannel(@Nonnull String name);
+
     /**
      * Modifies the positional order of this Category's nested {@link #getTextChannels() TextChannels} and {@link #getNewsChannels() NewsChannels}.
      * <br>This uses an extension of {@link ChannelOrderAction ChannelOrderAction}

src/main/java/net/dv8tion/jda/api/entities/Channel.java

@@ -30,6 +30,8 @@
  */
 public interface Channel extends IMentionable
 {
+    int MAX_NAME_LENGTH = 100;
+
     /**
      * The human readable name of this channel.
      *

src/main/java/net/dv8tion/jda/api/entities/ChannelType.java

@@ -56,6 +56,8 @@ public enum ChannelType
     GUILD_PUBLIC_THREAD(11, -1, true),
     GUILD_PRIVATE_THREAD(12, -1, true),
 
+    FORUM(15, 0, true),
+
     /**
      * Unknown Discord channel type. Should never happen and would only possibly happen if Discord implemented a new
      * channel type and JDA had yet to implement support for it.