|
22 | 22 | package com.falsepattern.lib.config; |
23 | 23 |
|
24 | 24 | import org.intellij.lang.annotations.Language; |
| 25 | +import org.jetbrains.annotations.ApiStatus; |
25 | 26 |
|
26 | 27 | import java.lang.annotation.Documented; |
27 | 28 | import java.lang.annotation.ElementType; |
|
94 | 95 | * Define category migrations here. |
95 | 96 | * Used to rename config categories without losing data. |
96 | 97 | * @see #pathMigrations() |
97 | | - * |
98 | | - * @since 1.5.0 |
99 | 98 | */ |
| 99 | + @ApiStatus.AvailableSince("1.5.0") |
100 | 100 | String[] categoryMigrations() default {}; |
101 | 101 |
|
102 | 102 | /** |
|
110 | 110 | * customPath = "mymod.config" -> .minecraft/config/mymod.config |
111 | 111 | * <br> |
112 | 112 | * @see #modid() |
113 | | - * |
114 | | - * @since 1.5.0 |
115 | 113 | */ |
| 114 | + @ApiStatus.AvailableSince("1.5.0") |
116 | 115 | String customPath() default ""; |
117 | 116 |
|
118 | 117 | /** |
|
126 | 125 | * the category of this config. |
127 | 126 | * @see #customPath() |
128 | 127 | * @see #categoryMigrations() |
129 | | - * |
130 | | - * @since 1.5.0 |
131 | 128 | */ |
| 129 | + @ApiStatus.AvailableSince("1.5.0") |
132 | 130 | String[] pathMigrations() default {}; |
133 | 131 |
|
134 | 132 | // region Common |
|
182 | 180 |
|
183 | 181 | /** |
184 | 182 | * Use this to migrate from old config names. "" is resolved to the name of the field |
185 | | - * |
186 | | - * @since 1.5.0 |
187 | 183 | */ |
| 184 | + @ApiStatus.AvailableSince("1.5.0") |
188 | 185 | String[] migrations() default {}; |
189 | 186 | } |
190 | 187 |
|
|
214 | 211 | * <p> |
215 | 212 | * Note that synchronization ALWAYS happens FROM the server TO the client. The server should NEVER attempt to get |
216 | 213 | * configuration values from a client. This is to avoid malicious clients manipulating the server configs. |
217 | | - * |
218 | | - * @since 0.10.0 |
219 | 214 | */ |
| 215 | + @ApiStatus.AvailableSince("0.10.0") |
220 | 216 | @Documented |
221 | 217 | @Retention(RetentionPolicy.RUNTIME) |
222 | 218 | @Target(ElementType.TYPE) |
223 | 219 | @interface Synchronize {} |
224 | 220 |
|
225 | 221 | /** |
226 | 222 | * Use this to mark config fields you don't want to synchronize in a class marked with {@link Synchronize}. |
227 | | - * |
228 | | - * @since 0.10.0 |
229 | 223 | */ |
| 224 | + @ApiStatus.AvailableSince("0.10.0") |
230 | 225 | @Documented |
231 | 226 | @Retention(RetentionPolicy.RUNTIME) |
232 | 227 | @Target(ElementType.FIELD) |
|
281 | 276 | /** |
282 | 277 | * The default value for a double field. |
283 | 278 | * @see RangeDouble |
284 | | - * |
285 | | - * @since 0.10.0 |
286 | 279 | */ |
| 280 | + @ApiStatus.AvailableSince("0.10.0") |
287 | 281 | @Documented |
288 | 282 | @Retention(RetentionPolicy.RUNTIME) |
289 | 283 | @Target(ElementType.FIELD) |
|
293 | 287 |
|
294 | 288 | /** |
295 | 289 | * The range of possible values a double config can have. |
296 | | - * |
297 | | - * @since 0.10.0 |
298 | 290 | */ |
| 291 | + @ApiStatus.AvailableSince("0.10.0") |
299 | 292 | @Documented |
300 | 293 | @Retention(RetentionPolicy.RUNTIME) |
301 | 294 | @Target(ElementType.FIELD) |
|
325 | 318 | * This annotation limits the maximum number of characters present in a string configuration. |
326 | 319 | * <p> |
327 | 320 | * When used with a string list, this limit will apply to each element individually, not to the size of the list as a whole. |
328 | | - * |
329 | | - * @since 0.10.0 |
330 | 321 | */ |
| 322 | + @ApiStatus.AvailableSince("0.10.0") |
331 | 323 | @Documented |
332 | 324 | @Retention(RetentionPolicy.RUNTIME) |
333 | 325 | @Target(ElementType.FIELD) |
|
368 | 360 | * The default value for a boolean array field. |
369 | 361 | * @see ListFixedLength |
370 | 362 | * @see ListMaxLength |
371 | | - * |
372 | | - * @since 0.10.0 |
373 | 363 | */ |
| 364 | + @ApiStatus.AvailableSince("0.10.0") |
374 | 365 | @Documented |
375 | 366 | @Retention(RetentionPolicy.RUNTIME) |
376 | 367 | @Target(ElementType.FIELD) |
|
383 | 374 | * @see ListFixedLength |
384 | 375 | * @see ListMaxLength |
385 | 376 | * @see RangeInt |
386 | | - * |
387 | | - * @since 0.10.0 |
388 | 377 | */ |
| 378 | + @ApiStatus.AvailableSince("0.10.0") |
389 | 379 | @Documented |
390 | 380 | @Retention(RetentionPolicy.RUNTIME) |
391 | 381 | @Target(ElementType.FIELD) |
|
398 | 388 | * @see ListFixedLength |
399 | 389 | * @see ListMaxLength |
400 | 390 | * @see RangeDouble |
401 | | - * |
402 | | - * @since 0.10.0 |
403 | 391 | */ |
| 392 | + @ApiStatus.AvailableSince("0.10.0") |
404 | 393 | @Documented |
405 | 394 | @Retention(RetentionPolicy.RUNTIME) |
406 | 395 | @Target(ElementType.FIELD) |
|
426 | 415 | * If this annotation is present, the list in the config will be forced to have exactly the amount of elements as |
427 | 416 | * the default value. |
428 | 417 | * @see ListMaxLength |
429 | | - * |
430 | | - * @since 0.10.0 |
431 | 418 | */ |
| 419 | + @ApiStatus.AvailableSince("0.10.0") |
432 | 420 | @Documented |
433 | 421 | @Retention(RetentionPolicy.RUNTIME) |
434 | 422 | @Target(ElementType.FIELD) |
|
437 | 425 | /** |
438 | 426 | * This annotation limits the maximum number of elements present in an array configuration. Only effective if |
439 | 427 | * {@link ListFixedLength} is NOT present. |
440 | | - * |
441 | | - * @since 0.10.0 |
442 | 428 | */ |
| 429 | + @ApiStatus.AvailableSince("0.10.0") |
443 | 430 | @Documented |
444 | 431 | @Retention(RetentionPolicy.RUNTIME) |
445 | 432 | @Target(ElementType.FIELD) |
|
0 commit comments