Package xyz.janboerman.scalaloader.configurationserializable

Annotation Interface Scan.IncludeProperty

Enclosing class:
Scan
@Target({METHOD,FIELD}) public static @interface Scan.IncludeProperty
Fields and methods annotated with this annotation will be considered when generating the serialization and deserialization methods.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    adapt
    Detect the property name based on the method name.
    String
    value
    The name of the property used in the yaml.

  • Element Details

    • value

      String value
      The name of the property used in the yaml. If set to the empty string, the property will be derived from the field or method name.
      Returns:
      the name of the property
      Default:
      ""

    • adapt

      boolean adapt

      Detect the property name based on the method name. This means that a property name such as 'height' can be derived from a method which uses the java bean convention 'getHeight'. The same goes for Scala naming conventions such as 'width_=' (in bytecode 'width_$eq')

      When set to false, the exact name of the method will be used.

      Returns:
      whether the property name should be adapted from the method name.
      Default:
      true