com.vaadin.flow.templatemodel

Annotation Type Encode

@Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Repeatable(value=Encode.Container.class)
public @interface Encode

Defines a ModelEncoder on a template model property found through path().

Use this annotation on setters in your TemplateModel class to perform type conversions on properties.

Since:

1.0

Author:

Vaadin Ltd

See Also:

ModelEncoder

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<? extends ModelEncoder<?,?>>	value The ModelEncoder class to use for encoding the property found through {path().

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	path The dot separated path from the TemplateModel property to the value to apply encoding to.

Element Detail

value

public abstract Class<? extends ModelEncoder<?,?>> value

The ModelEncoder class to use for encoding the property found through {path().

Returns:

the ModelEncoder class

path

public abstract String path

The dot separated path from the TemplateModel property to the value to apply encoding to. Empty string by default, which will apply encoding directly to the property.

Returns:

the dot separated path to the bean property to encode, empty string by default

Default:

""