ConvertProperty0.31.0

During rendering, the annotation's render function is called. The function must return a Pair of the converted property name and value.

Multiple ConvertProperty annotations can apply per property, and the output of one annotation's render function is used as input to the next. Annotations are applied the order as declared on the property. If the annotated property is overriding a parent property, the parent property's annotations are applied first.

These conversions can coexist with BaseValueRenderer.converters, and applies first.

These conversions only affect rendering of class properties. Applying this to other types of members does not impact rendering.

These conversions can be overriden with BaseValueRenderer.convertPropertyTransformers.

Example:

// convert duration to the number of seconds
@ConvertProperty {
  render = (property, _) -> Pair(property.key, property.value.toUnit("s"))
}
timeout: Duration

ConvertProperty can be subclassed to define re-usable property converters. The conversion defined in the previous example can be rewritten as:

class ConvertDuration extends ConvertProperty {
  unit: DurationUnit

  render = (property: Pair<String, Duration>, _) -> Pair(property.key, property.value.toUnit(unit))
}

@ConvertDuration { unit = "s" }
timeout: Duration