net.dv8tion.jda.api.entities.channel.unions.MessageChannelUnion Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of JDA Show documentation
Show all versions of JDA Show documentation
Java wrapper for the popular chat & VOIP service: Discord https://discord.com
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dv8tion.jda.api.entities.channel.unions;
import net.dv8tion.jda.api.entities.channel.ChannelType;
import net.dv8tion.jda.api.entities.channel.attribute.IThreadContainer;
import net.dv8tion.jda.api.entities.channel.concrete.*;
import net.dv8tion.jda.api.entities.channel.middleman.AudioChannel;
import net.dv8tion.jda.api.entities.channel.middleman.GuildMessageChannel;
import net.dv8tion.jda.api.entities.channel.middleman.MessageChannel;
import javax.annotation.Nonnull;
/**
* A union representing all channel types that implement {@link MessageChannel}.
*
This class extends {@link MessageChannel} and primarily acts as a discovery tool for
* developers to discover some common interfaces that a {@link MessageChannel} could be cast to.
*
*
This interface represents the follow concrete channel types:
*
* - {@link TextChannel}
* - {@link NewsChannel}
* - {@link VoiceChannel}
* - {@link StageChannel}
* - {@link ThreadChannel}
* - {@link PrivateChannel}
*
*/
public interface MessageChannelUnion extends MessageChannel
{
/**
* Casts this union to a {@link PrivateChannel}.
* This method exists for developer discoverability.
*
* Note: This is effectively equivalent to using the cast operator:
*
* //These are the same!
* PrivateChannel channel = union.asPrivateChannel();
* PrivateChannel channel2 = (PrivateChannel) union;
*
*
* You can use {@link #getType()} to see if the channel is of type {@link ChannelType#PRIVATE} to validate
* whether you can call this method in addition to normal instanceof checks: channel instanceof PrivateChannel
*
* @throws IllegalStateException
* If the channel represented by this union is not actually a {@link PrivateChannel}.
*
* @return The channel as a {@link PrivateChannel}
*/
@Nonnull
PrivateChannel asPrivateChannel();
/**
* Casts this union to a {@link TextChannel}.
* This method exists for developer discoverability.
*
* Note: This is effectively equivalent to using the cast operator:
*
* //These are the same!
* TextChannel channel = union.asTextChannel();
* TextChannel channel2 = (TextChannel) union;
*
*
* You can use {@link #getType()} to see if the channel is of type {@link ChannelType#TEXT} to validate
* whether you can call this method in addition to normal instanceof checks: channel instanceof TextChannel
*
* @throws IllegalStateException
* If the channel represented by this union is not actually a {@link TextChannel}.
*
* @return The channel as a {@link TextChannel}
*/
@Nonnull
TextChannel asTextChannel();
/**
* Casts this union to a {@link NewsChannel}.
* This method exists for developer discoverability.
*
* Note: This is effectively equivalent to using the cast operator:
*
* //These are the same!
* NewsChannel channel = union.asNewsChannel();
* NewsChannel channel2 = (NewsChannel) union;
*
*
* You can use {@link #getType()} to see if the channel is of type {@link ChannelType#NEWS} to validate
* whether you can call this method in addition to normal instanceof checks: channel instanceof NewsChannel
*
* @throws IllegalStateException
* If the channel represented by this union is not actually a {@link NewsChannel}.
*
* @return The channel as a {@link NewsChannel}
*/
@Nonnull
NewsChannel asNewsChannel();
/**
* Casts this union to a {@link ThreadChannel}.
* This method exists for developer discoverability.
*
* Note: This is effectively equivalent to using the cast operator:
*
* //These are the same!
* ThreadChannel channel = union.asThreadChannel();
* ThreadChannel channel2 = (ThreadChannel) union;
*
*
* You can use {@link #getType()}{@link ChannelType#isThread() .isThread()} to validate
* whether you can call this method in addition to normal instanceof checks: channel instanceof ThreadChannel
*
* @throws IllegalStateException
* If the channel represented by this union is not actually a {@link ThreadChannel}.
*
* @return The channel as a {@link ThreadChannel}
*/
@Nonnull
ThreadChannel asThreadChannel();
/**
* Casts this union to a {@link VoiceChannel}.
* This method exists for developer discoverability.
*
* Note: This is effectively equivalent to using the cast operator:
*
* //These are the same!
* VoiceChannel channel = union.asVoiceChannel();
* VoiceChannel channel2 = (VoiceChannel) union;
*
*
* You can use {@link #getType()} to see if the channel is of type {@link ChannelType#VOICE} to validate
* whether you can call this method in addition to normal instanceof checks: channel instanceof VoiceChannel
*
* @throws IllegalStateException
* If the channel represented by this union is not actually a {@link VoiceChannel}.
*
* @return The channel as a {@link VoiceChannel}
*/
@Nonnull
VoiceChannel asVoiceChannel();
/**
* Casts this union to a {@link StageChannel}.
* This method exists for developer discoverability.
*
* Note: This is effectively equivalent to using the cast operator:
*
* //These are the same!
* StageChannel channel = union.asStageChannel();
* StageChannel channel2 = (StageChannel) union;
*
*
* You can use {@link #getType()} to see if the channel is of type {@link ChannelType#STAGE} to validate
* whether you can call this method in addition to normal instanceof checks: channel instanceof StageChannel
*
* @throws IllegalStateException
* If the channel represented by this union is not actually a {@link StageChannel}.
*
* @return The channel as a {@link StageChannel}
*/
@Nonnull
StageChannel asStageChannel();
/**
* Casts this union to a {@link net.dv8tion.jda.api.entities.channel.attribute.IThreadContainer}.
* This method exists for developer discoverability.
*
* Note: This is effectively equivalent to using the cast operator:
*
* //These are the same!
* IThreadContainer channel = union.asThreadContainer();
* IThreadContainer channel2 = (IThreadContainer) union;
*
*
* You can use channel instanceof IThreadContainer to validate whether you can call this method.
*
* @throws IllegalStateException
* If the channel represented by this union is not actually a {@link net.dv8tion.jda.api.entities.channel.attribute.IThreadContainer}.
*
* @return The channel as a {@link net.dv8tion.jda.api.entities.channel.attribute.IThreadContainer}
*/
@Nonnull
IThreadContainer asThreadContainer();
/**
* Casts this union to a {@link GuildMessageChannel}.
*
This works for the following channel types represented by this union:
*
* - {@link TextChannel}
* - {@link NewsChannel}
* - {@link ThreadChannel}
*
*
* Note: This is effectively equivalent to using the cast operator:
*
* //These are the same!
* GuildMessageChannel channel = union.asGuildMessageChannel();
* GuildMessageChannel channel2 = (GuildMessageChannel) union;
*
*
* You can use {@link #getType()}{@link ChannelType#isGuild() .isGuild()} to validate
* whether you can call this method in addition to normal instanceof checks: channel instanceof GuildMessageChannel
*
* @throws IllegalStateException
* If the channel represented by this union is not actually a {@link GuildMessageChannel}.
*
* @return The channel as a {@link GuildMessageChannel}
*/
@Nonnull
GuildMessageChannel asGuildMessageChannel();
/**
* Casts this union to a {@link AudioChannel}.
* This method exists for developer discoverability.
*
* Note: This is effectively equivalent to using the cast operator:
*
* //These are the same!
* AudioChannel channel = union.asAudioChannel();
* AudioChannel channel2 = (AudioChannel) union;
*
*
* You can use channel instanceof AudioChannel to validate whether you can call this method.
*
* @throws IllegalStateException
* If the channel represented by this union is not actually a {@link AudioChannel}.
*
* @return The channel as a {@link AudioChannel}
*/
@Nonnull
AudioChannel asAudioChannel();
}