|
26 | 26 | import java.util.List; |
27 | 27 |
|
28 | 28 | /** |
29 | | - * Class containing all (known) Bot lists. |
30 | | - * <br>The static instances of this class allow the easy use within various methods of the JavaBotBlockAPI. |
| 29 | + * This class contains all known sites that are supported by BotBlock's APIs for getting Bot info, getting list info or |
| 30 | + * posting Bot info to a list. |
31 | 31 | * |
32 | | - * <p>Keep in mind that not all Sites support either GET or POST requests. You may use {@link #supportsGet() supportsGet()} |
33 | | - * or {@link #supportsPost() supportsPost()} methods to check whether the instance supports GET and/or POST respectively. |
| 32 | + * <p>The static instances of this class allow an easy and quick usage in various methods of JavaBotBlockAPI without the |
| 33 | + * need to remember any bot list name. |
| 34 | + * |
| 35 | + * <h2>Supported HTTP Methods</h2> |
| 36 | + * The Javadoc comment of each instance lists what HTTP method is supported. |
| 37 | + * <br>If a List supports GET can you use all methods from the GetListAction and GetBotAction classes of the Request module |
| 38 | + * while Lists supporting POST also can be utilized within the {@link org.botblock.javabotblockapi.core.BotBlockAPI BotBlockAPI} |
| 39 | + * to posts Bot information to that list. |
| 40 | + * |
| 41 | + * <p>Trying to use a List for an action it doesn't support (i.e. using a List for POST while it only supports GET) will |
| 42 | + * result in exceptions being thrown. |
| 43 | + * <br><b>Instances marked as Deprecated won't support either method type. If a replacement is mentioned using the |
| 44 | + * {@link org.botblock.javabotblockapi.core.annotations.DeprecatedSince DeprecatedSince's} replacement value should it |
| 45 | + * be used in favour of the deprecated Instance.</b> |
34 | 46 | * |
35 | 47 | * @since 6.3.0 |
36 | 48 | */ |
@@ -70,22 +82,6 @@ public class Site{ |
70 | 82 | */ |
71 | 83 | public static final Site BLIST_XYZ = new Site("blist.xyz", HttpMethod.GET, HttpMethod.POST); |
72 | 84 |
|
73 | | - /** |
74 | | - * <a href="https://botlist.space" target="_blank">botlist.space</a> |
75 | | - * |
76 | | - * <p>Supported methods: |
77 | | - * <ul> |
78 | | - * <li>GET</li> |
79 | | - * <li>POST</li> |
80 | | - * </ul> |
81 | | - * |
82 | | - * @deprecated Domain changed to {@link #DISCORDLIST_SPACE discordlist.space} |
83 | | - */ |
84 | | - @Deprecated |
85 | | - @DeprecatedSince(major = 6, minor = 6, patch = 3, replacements = {"DISCORDLIST_SPACE"}) |
86 | | - @PlannedRemoval(major = 6, minor = 6, patch = 5) |
87 | | - public static final Site BOTLIST_SPACE = new Site("botlist.space"); |
88 | | - |
89 | 85 | /** |
90 | 86 | * <a href="https://botsdatabase.com" target="_blank">botsdatabase.com</a> |
91 | 87 | * |
|
0 commit comments