Package org.spongepowered.configurate.objectmapping.meta

Annotation Type Setting

@Keep @Documented @Retention(RUNTIME) @Target(FIELD) public @interface Setting
Marks a field to be targeted by the object mapper.

Optionally, a path override can be provided.

This annotation is not required on fields unless the NodeResolver.onlyWithSetting() resolver filter has been applied to the loading object mapper.

Since:
4.0.0

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    nodeFromParent
    Whether a field should use its containing node for its value.
    String
    value
    The path this setting is located at.

  • Element Details

    • value

      String value
      The path this setting is located at.
      Returns:
      the path
      Since:
      4.0.0
      Default:
      ""

    • nodeFromParent

      boolean nodeFromParent
      Whether a field should use its containing node for its value.
      Returns:
      whether this field should source its data from the node of its container
      Since:
      4.0.0
      Default:
      false