/
GenericChannelEvent.java
91 lines (79 loc) · 2.96 KB
/
GenericChannelEvent.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*
* 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.events.channel;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.entities.channel.Channel;
import net.dv8tion.jda.api.entities.channel.ChannelType;
import net.dv8tion.jda.api.entities.channel.middleman.GuildChannel;
import net.dv8tion.jda.api.entities.channel.unions.ChannelUnion;
import net.dv8tion.jda.api.events.Event;
import javax.annotation.Nonnull;
//TODO-v5: Docs
public class GenericChannelEvent extends Event
{
protected final Channel channel;
public GenericChannelEvent(@Nonnull JDA api, long responseNumber, Channel channel)
{
super(api, responseNumber);
this.channel = channel;
}
/**
* Whether this channel event happened in a {@link net.dv8tion.jda.api.entities.Guild Guild}.
* <br>If this is {@code false} then {@link #getGuild()} will throw an {@link java.lang.IllegalStateException}.
*
* @return True, if {@link #getChannelType()}.{@link ChannelType#isGuild() isGuild()} is true.
*/
public boolean isFromGuild()
{
return getChannelType().isGuild();
}
@Nonnull
public ChannelType getChannelType()
{
return this.channel.getType();
}
public boolean isFromType(ChannelType type)
{
return getChannelType() == type;
}
@Nonnull
public ChannelUnion getChannel()
{
return (ChannelUnion) this.channel;
}
/**
* The {@link net.dv8tion.jda.api.entities.Guild Guild} in which this channel event happened.
* <br>If this channel event was not received in a {@link net.dv8tion.jda.api.entities.channel.concrete.TextChannel TextChannel},
* this will throw an {@link java.lang.IllegalStateException}.
*
* @throws java.lang.IllegalStateException
* If this channel event did not happen in a {@link net.dv8tion.jda.api.entities.channel.middleman.GuildChannel}.
*
* @return The Guild in which this channel event happened
*
* @see #isFromType(ChannelType)
* @see #getChannelType()
*/
@Nonnull
public Guild getGuild()
{
if (!isFromGuild())
throw new IllegalStateException("This channel event did not happen in a guild");
return ((GuildChannel) channel).getGuild();
}
//TODO-v5: Add getters for all channel types
}