Skip to content

Annotation Catalog

Serialization Annotations

  • Structure


    Generates a structure for the target. serialName can be specified to change the identifier used. serializable: true can be used to also make the structure serializable.

  • Serializable / serializable


    Aliases for serializable Structures. serialName can be specified to change the identifier used.

  • EnumProperty


    The name of the enum constant can be overridden using the name parameter. Additionally, a single constant can be marked as fallback to handle invalid enum values.

  • polymorphic


    Marks a field as polymorphic so that the actual runtime type is used for serialization.

  • PropertySerializer


    Specifies the type of custom converter to be used for this fields' serialization.

  • PropertyName


    Changes the name of the property used in serialization.

  • DefaultValue


    Sets a default value for the field. If keep is false, the field will be omitted in serialization if it has the default value.

  • excludeNull


    If applied to a member, direct null values will be excluded from serialization.

  • LightweightMigration


    Applies a list of functions on deserialization to migrate data from older versions.

  • RevisionMigration


    Applies migrations based on the revision number added to the map output.

Validation Annotations

  • LengthRange
  • Regex
  • email
  • notBlank

  • Range

  • Minimum
  • Maximum
  • positive
  • positiveOrZero
  • negative
  • negativeOrZero
  • SizeRange
  • validated