/
IGuildChannelContainer.java
1103 lines (1035 loc) · 57.3 KB
/
IGuildChannelContainer.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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* 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;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.entities.*;
import net.dv8tion.jda.api.sharding.ShardManager;
import net.dv8tion.jda.api.utils.MiscUtil;
import net.dv8tion.jda.api.utils.cache.CacheView;
import net.dv8tion.jda.api.utils.cache.SnowflakeCacheView;
import net.dv8tion.jda.internal.utils.Checks;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.List;
/**
* Provides various channel cache getters for Guild channels.
*
* <p>These getters only check the caches with the relevant scoping of the implementing type.
* For example, {@link Guild} returns channels that exist within the guild,
* whereas {@link JDA} or {@link ShardManager} returns any channels that exist within the shard.
*
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* <p>For the most efficient usage, it is recommended to use {@link CacheView} getters such as {@link #getTextChannelCache()}.
* List getters usually require making a snapshot copy of the underlying cache view, which may introduce an undesirable performance hit.
*/
public interface IGuildChannelContainer
{
/**
* Get a channel of the specified type by id.
*
* <p>This will automatically check for all channel types and cast to the specified class.
* If a channel with the specified id does not exist,
* or exists but is not an instance of the provided class, this returns null.
*
* @param type
* {@link Class} of a channel type
* @param id
* The snowflake id of the channel
* @param <T>
* The type argument for the class
*
* @throws IllegalArgumentException
* If null is provided, or the id is not a valid snowflake
*
* @return The casted channel, if it exists and is assignable to the provided class, or null
*/
@Nullable
default <T extends Channel> T getChannelById(@Nonnull Class<T> type, @Nonnull String id)
{
return getChannelById(type, MiscUtil.parseSnowflake(id));
}
/**
* Get a channel of the specified type by id.
*
* <p>This will automatically check for all channel types and cast to the specified class.
* If a channel with the specified id does not exist,
* or exists but is not an instance of the provided class, this returns null.
*
* @param type
* {@link Class} of a channel type
* @param id
* The snowflake id of the channel
* @param <T>
* The type argument for the class
*
* @throws IllegalArgumentException
* If null is provided
*
* @return The casted channel, if it exists and is assignable to the provided class, or null
*/
@Nullable
default <T extends Channel> T getChannelById(@Nonnull Class<T> type, long id)
{
Checks.notNull(type, "Class");
GuildChannel channel = getGuildChannelById(id);
return type.isInstance(channel) ? type.cast(channel) : null;
}
/**
* Get {@link GuildChannel GuildChannel} for the provided ID.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* <p>To get more specific channel types you can use one of the following:
* <ul>
* <li>{@link #getChannelById(Class, String)}</li>
* <li>{@link #getTextChannelById(String)}</li>
* <li>{@link #getNewsChannelById(String)}</li>
* <li>{@link #getStageChannelById(String)}</li>
* <li>{@link #getVoiceChannelById(String)}</li>
* <li>{@link #getStoreChannelById(String)}</li>
* <li>{@link #getCategoryById(String)}</li>
* </ul>
*
* @param id
* The ID of the channel
*
* @throws java.lang.IllegalArgumentException
* If the provided ID is null
* @throws java.lang.NumberFormatException
* If the provided ID is not a snowflake
*
* @return The GuildChannel or null
*/
@Nullable
default GuildChannel getGuildChannelById(@Nonnull String id)
{
return getGuildChannelById(MiscUtil.parseSnowflake(id));
}
/**
* Get {@link GuildChannel GuildChannel} for the provided ID.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* <p>To get more specific channel types you can use one of the following:
* <ul>
* <li>{@link #getChannelById(Class, long)}</li>
* <li>{@link #getTextChannelById(long)}</li>
* <li>{@link #getNewsChannelById(long)}</li>
* <li>{@link #getStageChannelById(long)}</li>
* <li>{@link #getVoiceChannelById(long)}</li>
* <li>{@link #getStoreChannelById(long)}</li>
* <li>{@link #getCategoryById(long)}</li>
* </ul>
*
* @param id
* The ID of the channel
*
* @return The GuildChannel or null
*/
@Nullable
default GuildChannel getGuildChannelById(long id)
{
//TODO-v5-unified-channel-cache
GuildChannel channel = getTextChannelById(id);
if (channel == null)
channel = getNewsChannelById(id);
if (channel == null)
channel = getVoiceChannelById(id);
if (channel == null)
channel = getStageChannelById(id);
if (channel == null)
channel = getStoreChannelById(id);
if (channel == null)
channel = getCategoryById(id);
if (channel == null)
channel = getThreadChannelById(id);
return channel;
}
/**
* Get {@link GuildChannel GuildChannel} for the provided ID.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* <br>This is meant for systems that use a dynamic {@link net.dv8tion.jda.api.entities.ChannelType} and can
* profit from a simple function to get the channel instance.
*
* <p>To get more specific channel types you can use one of the following:
* <ul>
* <li>{@link #getChannelById(Class, String)}</li>
* <li>{@link #getTextChannelById(String)}</li>
* <li>{@link #getNewsChannelById(String)}</li>
* <li>{@link #getStageChannelById(String)}</li>
* <li>{@link #getVoiceChannelById(String)}</li>
* <li>{@link #getStoreChannelById(String)}</li>
* <li>{@link #getCategoryById(String)}</li>
* </ul>
*
* @param type
* The {@link net.dv8tion.jda.api.entities.ChannelType}
* @param id
* The ID of the channel
*
* @throws java.lang.IllegalArgumentException
* If the provided ID is null
* @throws java.lang.NumberFormatException
* If the provided ID is not a snowflake
*
* @return The GuildChannel or null
*/
@Nullable
default GuildChannel getGuildChannelById(@Nonnull ChannelType type, @Nonnull String id)
{
return getGuildChannelById(type, MiscUtil.parseSnowflake(id));
}
/**
* Get {@link GuildChannel GuildChannel} for the provided ID.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* <br>This is meant for systems that use a dynamic {@link net.dv8tion.jda.api.entities.ChannelType} and can
* profit from a simple function to get the channel instance.
*
* <p>To get more specific channel types you can use one of the following:
* <ul>
* <li>{@link #getChannelById(Class, long)}</li>
* <li>{@link #getTextChannelById(long)}</li>
* <li>{@link #getNewsChannelById(long)}</li>
* <li>{@link #getStageChannelById(long)}</li>
* <li>{@link #getVoiceChannelById(long)}</li>
* <li>{@link #getStoreChannelById(long)}</li>
* <li>{@link #getCategoryById(long)}</li>
* </ul>
*
* @param type
* The {@link net.dv8tion.jda.api.entities.ChannelType}
* @param id
* The ID of the channel
*
* @return The GuildChannel or null
*/
@Nullable
default GuildChannel getGuildChannelById(@Nonnull ChannelType type, long id)
{
Checks.notNull(type, "ChannelType");
switch (type)
{
case NEWS:
return getNewsChannelById(id);
case TEXT:
return getTextChannelById(id);
case VOICE:
return getVoiceChannelById(id);
case STAGE:
return getStageChannelById(id);
case STORE:
return getStoreChannelById(id);
case CATEGORY:
return getCategoryById(id);
}
if (type.isThread())
return getThreadChannelById(id);
return null;
}
// Stages
/**
* Sorted {@link net.dv8tion.jda.api.utils.cache.SnowflakeCacheView SnowflakeCacheView} of {@link StageChannel}.
* <br>In {@link Guild} cache, channels are sorted according to their position and id.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @return {@link net.dv8tion.jda.api.utils.cache.SortedSnowflakeCacheView SortedSnowflakeCacheView}
*/
@Nonnull
SnowflakeCacheView<StageChannel> getStageChannelCache();
/**
* Gets a list of all {@link net.dv8tion.jda.api.entities.StageChannel StageChannels}
* in this Guild that have the same name as the one provided.
* <br>If there are no channels with the provided name, then this returns an empty list.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param name
* The name used to filter the returned {@link net.dv8tion.jda.api.entities.StageChannel StageChannels}.
* @param ignoreCase
* Determines if the comparison ignores case when comparing. True - case insensitive.
*
* @return Possibly-empty immutable list of all StageChannel names that match the provided name.
*/
@Nonnull
default List<StageChannel> getStageChannelsByName(@Nonnull String name, boolean ignoreCase)
{
return getStageChannelCache().getElementsByName(name, ignoreCase);
}
/**
* Gets a {@link net.dv8tion.jda.api.entities.StageChannel StageChannel} that has the same id as the one provided.
* <br>If there is no channel with an id that matches the provided one, then this returns {@code null}.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param id
* The id of the {@link net.dv8tion.jda.api.entities.StageChannel StageChannel}.
*
* @throws java.lang.NumberFormatException
* If the provided {@code id} cannot be parsed by {@link Long#parseLong(String)}
*
* @return Possibly-null {@link net.dv8tion.jda.api.entities.StageChannel StageChannel} with matching id.
*/
@Nullable
default StageChannel getStageChannelById(@Nonnull String id)
{
return getStageChannelCache().getElementById(id);
}
/**
* Gets a {@link net.dv8tion.jda.api.entities.StageChannel StageChannel} that has the same id as the one provided.
* <br>If there is no channel with an id that matches the provided one, then this returns {@code null}.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param id
* The id of the {@link net.dv8tion.jda.api.entities.StageChannel StageChannel}.
*
* @return Possibly-null {@link net.dv8tion.jda.api.entities.StageChannel StageChannel} with matching id.
*/
@Nullable
default StageChannel getStageChannelById(long id)
{
return getStageChannelCache().getElementById(id);
}
/**
* Gets all {@link net.dv8tion.jda.api.entities.StageChannel StageChannels} in the cache.
* <br>In {@link Guild} cache, channels are sorted according to their position and id.
*
* <p>This copies the backing store into a list. This means every call
* creates a new list with O(n) complexity. It is recommended to store this into
* a local variable or use {@link #getStageChannelCache()} and use its more efficient
* versions of handling these values.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @return An immutable List of {@link net.dv8tion.jda.api.entities.StageChannel StageChannels}.
*/
@Nonnull
default List<StageChannel> getStageChannels()
{
return getStageChannelCache().asList();
}
// Threads
/**
* {@link net.dv8tion.jda.api.utils.cache.SnowflakeCacheView SnowflakeCacheView} of {@link ThreadChannel}.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @return {@link net.dv8tion.jda.api.utils.cache.SnowflakeCacheView SnowflakeCacheView}
*/
@Nonnull
SnowflakeCacheView<ThreadChannel> getThreadChannelCache();
/**
* Gets a list of all {@link net.dv8tion.jda.api.entities.ThreadChannel ThreadChannels}
* in this Guild that have the same name as the one provided.
* <br>If there are no channels with the provided name, then this returns an empty list.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param name
* The name used to filter the returned {@link ThreadChannel ThreadChannels}.
* @param ignoreCase
* Determines if the comparison ignores case when comparing. True - case insensitive.
*
* @return Possibly-empty immutable list of all ThreadChannel names that match the provided name.
*/
@Nonnull
default List<ThreadChannel> getThreadChannelsByName(@Nonnull String name, boolean ignoreCase)
{
return getThreadChannelCache().getElementsByName(name, ignoreCase);
}
/**
* Gets a {@link ThreadChannel ThreadChannel} that has the same id as the one provided.
* <br>If there is no channel with an id that matches the provided one, then this returns {@code null}.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param id
* The id of the {@link ThreadChannel ThreadChannel}.
*
* @throws java.lang.NumberFormatException
* If the provided {@code id} cannot be parsed by {@link Long#parseLong(String)}
*
* @return Possibly-null {@link ThreadChannel ThreadChannel} with matching id.
*/
@Nullable
default ThreadChannel getThreadChannelById(@Nonnull String id)
{
return getThreadChannelCache().getElementById(id);
}
/**
* Gets a {@link net.dv8tion.jda.api.entities.ThreadChannel ThreadChannel} that has the same id as the one provided.
* <br>If there is no channel with an id that matches the provided one, then this returns {@code null}.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param id
* The id of the {@link ThreadChannel ThreadChannel}.
*
* @return Possibly-null {@link ThreadChannel ThreadChannel} with matching id.
*/
@Nullable
default ThreadChannel getThreadChannelById(long id)
{
return getThreadChannelCache().getElementById(id);
}
/**
* Gets all {@link ThreadChannel ThreadChannel} in the cache.
*
* <p>This copies the backing store into a list. This means every call
* creates a new list with O(n) complexity. It is recommended to store this into
* a local variable or use {@link #getThreadChannelCache()} and use its more efficient
* versions of handling these values.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @return An immutable List of {@link ThreadChannel ThreadChannels}.
*/
@Nonnull
default List<ThreadChannel> getThreadChannels()
{
return getThreadChannelCache().asList();
}
// Categories
/**
* Sorted {@link net.dv8tion.jda.api.utils.cache.SnowflakeCacheView SnowflakeCacheView} of {@link Category}.
* <br>In {@link Guild} cache, channels are sorted according to their position and id.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @return {@link net.dv8tion.jda.api.utils.cache.SortedSnowflakeCacheView SortedSnowflakeCacheView}
*/
@Nonnull
SnowflakeCacheView<Category> getCategoryCache();
/**
* Gets a list of all {@link net.dv8tion.jda.api.entities.Category Categories}
* in this Guild that have the same name as the one provided.
* <br>If there are no channels with the provided name, then this returns an empty list.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param name
* The name to check
* @param ignoreCase
* Whether to ignore case on name checking
*
* @throws java.lang.IllegalArgumentException
* If the provided name is {@code null}
*
* @return Immutable list of all categories matching the provided name
*/
@Nonnull
default List<Category> getCategoriesByName(@Nonnull String name, boolean ignoreCase)
{
return getCategoryCache().getElementsByName(name, ignoreCase);
}
/**
* Gets a {@link net.dv8tion.jda.api.entities.Category Category} that has the same id as the one provided.
* <br>If there is no channel with an id that matches the provided one, then this returns {@code null}.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param id
* The snowflake ID of the wanted Category
*
* @throws java.lang.IllegalArgumentException
* If the provided ID is not a valid {@code long}
*
* @return Possibly-null {@link net.dv8tion.jda.api.entities.Category Category} for the provided ID.
*/
@Nullable
default Category getCategoryById(@Nonnull String id)
{
return getCategoryCache().getElementById(id);
}
/**
* Gets a {@link net.dv8tion.jda.api.entities.Category Category} that has the same id as the one provided.
* <br>If there is no channel with an id that matches the provided one, then this returns {@code null}.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param id
* The snowflake ID of the wanted Category
*
* @return Possibly-null {@link net.dv8tion.jda.api.entities.Category Category} for the provided ID.
*/
@Nullable
default Category getCategoryById(long id)
{
return getCategoryCache().getElementById(id);
}
/**
* Gets all {@link net.dv8tion.jda.api.entities.Category Categories} in the cache.
* <br>In {@link Guild} cache, channels are sorted according to their position and id.
*
* <p>This copies the backing store into a list. This means every call
* creates a new list with O(n) complexity. It is recommended to store this into
* a local variable or use {@link #getCategoryCache()} and use its more efficient
* versions of handling these values.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @return An immutable list of all {@link net.dv8tion.jda.api.entities.Category Categories} in this Guild.
*/
@Nonnull
default List<Category> getCategories()
{
return getCategoryCache().asList();
}
// StoreChannels
/**
* Sorted {@link net.dv8tion.jda.api.utils.cache.SnowflakeCacheView SnowflakeCacheView} of {@link StoreChannel}.
* <br>In {@link Guild} cache, channels are sorted according to their position and id.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @return {@link net.dv8tion.jda.api.utils.cache.SortedSnowflakeCacheView SortedSnowflakeCacheView}
*
* @since 4.0.0
*/
@Nonnull
SnowflakeCacheView<StoreChannel> getStoreChannelCache();
/**
* Gets a list of all {@link net.dv8tion.jda.api.entities.StoreChannel StoreChannels}
* in this Guild that have the same name as the one provided.
* <br>If there are no channels with the provided name, then this returns an empty list.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param name
* The name used to filter the returned {@link net.dv8tion.jda.api.entities.StoreChannel StoreChannels}.
* @param ignoreCase
* Determines if the comparison ignores case when comparing. True - case insensitive.
*
* @return Possibly-empty immutable list of all StoreChannels with names that match the provided name.
*
* @since 4.0.0
*/
@Nonnull
default List<StoreChannel> getStoreChannelsByName(@Nonnull String name, boolean ignoreCase)
{
return getStoreChannelCache().getElementsByName(name, ignoreCase);
}
/**
* Gets a {@link net.dv8tion.jda.api.entities.StoreChannel StoreChannel} that has the same id as the one provided.
* <br>If there is no channel with an id that matches the provided one, then this returns {@code null}.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param id
* The id of the {@link net.dv8tion.jda.api.entities.StoreChannel StoreChannel}.
*
* @throws java.lang.NumberFormatException
* If the provided {@code id} cannot be parsed by {@link Long#parseLong(String)}
*
* @return Possibly-null {@link net.dv8tion.jda.api.entities.StoreChannel StoreChannel} with matching id.
*
* @since 4.0.0
*/
@Nullable
default StoreChannel getStoreChannelById(@Nonnull String id)
{
return getStoreChannelCache().getElementById(id);
}
/**
* Gets a {@link net.dv8tion.jda.api.entities.StoreChannel StoreChannel} that has the same id as the one provided.
* <br>If there is no channel with an id that matches the provided one, then this returns {@code null}.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param id
* The id of the {@link net.dv8tion.jda.api.entities.StoreChannel StoreChannel}.
*
* @return Possibly-null {@link net.dv8tion.jda.api.entities.StoreChannel StoreChannel} with matching id.
*
* @since 4.0.0
*/
@Nullable
default StoreChannel getStoreChannelById(long id)
{
return getStoreChannelCache().getElementById(id);
}
/**
* Gets all {@link net.dv8tion.jda.api.entities.StoreChannel StoreChannel} in the cache.
* <br>In {@link Guild} cache, channels are sorted according to their position and id.
*
* <p>This copies the backing store into a list. This means every call
* creates a new list with O(n) complexity. It is recommended to store this into
* a local variable or use {@link #getStoreChannelCache()} and use its more efficient
* versions of handling these values.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @return An immutable List of all {@link net.dv8tion.jda.api.entities.StoreChannel StoreChannel} in this Guild.
*
* @since 4.0.0
*/
@Nonnull
default List<StoreChannel> getStoreChannels()
{
return getStoreChannelCache().asList();
}
// TextChannels
/**
* Sorted {@link net.dv8tion.jda.api.utils.cache.SnowflakeCacheView SnowflakeCacheView} of {@link TextChannel}.
* <br>In {@link Guild} cache, channels are sorted according to their position and id.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @return {@link net.dv8tion.jda.api.utils.cache.SortedSnowflakeCacheView SortedSnowflakeCacheView}
*/
@Nonnull
SnowflakeCacheView<TextChannel> getTextChannelCache();
/**
* Gets a list of all {@link net.dv8tion.jda.api.entities.TextChannel TextChannels}
* in this Guild that have the same name as the one provided.
* <br>If there are no channels with the provided name, then this returns an empty list.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param name
* The name used to filter the returned {@link net.dv8tion.jda.api.entities.TextChannel TextChannels}.
* @param ignoreCase
* Determines if the comparison ignores case when comparing. True - case insensitive.
*
* @return Possibly-empty immutable list of all TextChannels names that match the provided name.
*/
@Nonnull
default List<TextChannel> getTextChannelsByName(@Nonnull String name, boolean ignoreCase)
{
return getTextChannelCache().getElementsByName(name, ignoreCase);
}
/**
* Gets a {@link net.dv8tion.jda.api.entities.TextChannel TextChannel} that has the same id as the one provided.
* <br>If there is no channel with an id that matches the provided one, then this returns {@code null}.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param id
* The id of the {@link net.dv8tion.jda.api.entities.TextChannel TextChannel}.
*
* @throws java.lang.NumberFormatException
* If the provided {@code id} cannot be parsed by {@link Long#parseLong(String)}
*
* @return Possibly-null {@link net.dv8tion.jda.api.entities.TextChannel TextChannel} with matching id.
*/
@Nullable
default TextChannel getTextChannelById(@Nonnull String id)
{
return getTextChannelCache().getElementById(id);
}
/**
* Gets a {@link net.dv8tion.jda.api.entities.TextChannel TextChannel} that has the same id as the one provided.
* <br>If there is no channel with an id that matches the provided one, then this returns {@code null}.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param id
* The id of the {@link net.dv8tion.jda.api.entities.TextChannel TextChannel}.
*
* @return Possibly-null {@link net.dv8tion.jda.api.entities.TextChannel TextChannel} with matching id.
*/
@Nullable
default TextChannel getTextChannelById(long id)
{
return getTextChannelCache().getElementById(id);
}
/**
* Gets all {@link net.dv8tion.jda.api.entities.TextChannel TextChannels} in the cache.
* <br>In {@link Guild} cache, channels are sorted according to their position and id.
*
* <p>This copies the backing store into a list. This means every call
* creates a new list with O(n) complexity. It is recommended to store this into
* a local variable or use {@link #getTextChannelCache()} and use its more efficient
* versions of handling these values.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @return An immutable List of all {@link net.dv8tion.jda.api.entities.TextChannel TextChannels} in this Guild.
*/
@Nonnull
default List<TextChannel> getTextChannels()
{
return getTextChannelCache().asList();
}
// NewsChannels / AnnouncementChannels
/**
* Sorted {@link net.dv8tion.jda.api.utils.cache.SnowflakeCacheView SnowflakeCacheView} of {@link NewsChannel}.
* <br>In {@link Guild} cache, channels are sorted according to their position and id.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @return {@link net.dv8tion.jda.api.utils.cache.SortedSnowflakeCacheView SortedSnowflakeCacheView}
*/
@Nonnull
SnowflakeCacheView<NewsChannel> getNewsChannelCache();
/**
* Gets a list of all {@link net.dv8tion.jda.api.entities.NewsChannel NewsChannels}
* in this Guild that have the same name as the one provided.
* <br>If there are no channels with the provided name, then this returns an empty list.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param name
* The name used to filter the returned {@link net.dv8tion.jda.api.entities.NewsChannel NewsChannels}.
* @param ignoreCase
* Determines if the comparison ignores case when comparing. True - case insensitive.
*
* @return Possibly-empty immutable list of all NewsChannels names that match the provided name.
*/
@Nonnull
default List<NewsChannel> getNewsChannelsByName(@Nonnull String name, boolean ignoreCase)
{
return getNewsChannelCache().getElementsByName(name, ignoreCase);
}
/**
* Gets a {@link net.dv8tion.jda.api.entities.NewsChannel NewsChannel} that has the same id as the one provided.
* <br>If there is no channel with an id that matches the provided one, then this returns {@code null}.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param id
* The id of the {@link net.dv8tion.jda.api.entities.NewsChannel NewsChannel}.
*
* @throws java.lang.NumberFormatException
* If the provided {@code id} cannot be parsed by {@link Long#parseLong(String)}
*
* @return Possibly-null {@link net.dv8tion.jda.api.entities.NewsChannel NewsChannel} with matching id.
*/
@Nullable
default NewsChannel getNewsChannelById(@Nonnull String id)
{
return getNewsChannelCache().getElementById(id);
}
/**
* Gets a {@link net.dv8tion.jda.api.entities.NewsChannel NewsChannel} that has the same id as the one provided.
* <br>If there is no channel with an id that matches the provided one, then this returns {@code null}.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @param id
* The id of the {@link net.dv8tion.jda.api.entities.NewsChannel NewsChannel}.
*
* @return Possibly-null {@link net.dv8tion.jda.api.entities.NewsChannel NewsChannel} with matching id.
*/
@Nullable
default NewsChannel getNewsChannelById(long id)
{
return getNewsChannelCache().getElementById(id);
}
/**
* Gets all {@link net.dv8tion.jda.api.entities.NewsChannel NewsChannels} in the cache.
* <br>In {@link Guild} cache, channels are sorted according to their position and id.
*
* <p>This copies the backing store into a list. This means every call
* creates a new list with O(n) complexity. It is recommended to store this into
* a local variable or use {@link #getNewsChannelCache()} and use its more efficient
* versions of handling these values.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.
* To make sure the cache is initialized after building your {@link JDA} instance, you can use {@link JDA#awaitReady()}.
*
* @return An immutable List of all {@link net.dv8tion.jda.api.entities.NewsChannel NewsChannels} in this Guild.
*/
@Nonnull
default List<NewsChannel> getNewsChannels()
{
return getNewsChannelCache().asList();
}
// VoiceChannels
/**
* Sorted {@link net.dv8tion.jda.api.utils.cache.SnowflakeCacheView SnowflakeCacheView} of {@link VoiceChannel}.
* <br>In {@link Guild} cache, channels are sorted according to their position and id.
*
* <p>This getter exists on any instance of {@link IGuildChannelContainer} and only checks the caches with the relevant scoping.
* For {@link Guild}, {@link JDA}, or {@link ShardManager},
* this returns the relevant channel with respect to the cache within each of those objects.
* For a guild, this would mean it only returns channels within the same guild.
* <br>If this is called on {@link JDA} or {@link ShardManager}, this may return null immediately after building, because the cache isn't initialized yet.