Package org.spongepowered.configurate.interfaces.meta

Annotation Type Hidden

@Retention(RUNTIME)
@Target({METHOD,FIELD})
public @interface Hidden

This annotation allows you to read the config node as normal, but it only writes the node when the value is not the default value. This is to ensure that when a user manually adds the entry, it remains there (as long as it's not the default value.)

Without a default value the annotated node will be read, but will never be written even if the user explicitly added it to their config.

Note that Hidden doesn't work with default method getters due to a limitation, and Hidden will function like it doesn't have a default value.

Since:

4.2.0