blob: 94bf7859bedd5bdf8e949f388e02dda3ce3c9e51 (
plain)
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
|
package dev.isxander.yacl3.config.v2.api;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Marks a field as serializable, so it can be used in a {@link ConfigSerializer}.
* Any field without this annotation will not be saved or loaded, but can still be turned
* into an auto-generated option.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface SerialEntry {
/**
* The serial name of the field.
* If empty, the serializer will decide the name.
*/
String value() default "";
/**
* The comment to add to the field.
* Some serializers may not support this.
* If empty, the serializer will not add a comment.
*/
String comment() default "";
/**
* Whether the field is required in the loaded config to be valid.
* If it's not, the config will be marked as dirty and re-saved with the default value.
*/
boolean required() default true;
/**
* Whether the field can be null.
*/
boolean nullable() default false;
}
|
