com.vaadin.flow.templatemodel.Encode API 23.1.17 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.templatemodel.

```
@Deprecated
@Retention(RUNTIME)
@Target(METHOD)
@Repeatable(Container.class)
public @interface Encode
```
Deprecated.
Template model and polymer template support is deprecated - we recommend you to use LitTemplate instead. Read more details from the Vaadin blog.

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	Description
`Class<? extends ModelEncoder<?,?>>`	`value`	Deprecated. The ModelEncoder class to use for encoding the property found through {`path()`.

Optional Element Summary

Optional Elements
Modifier and Type Optional Element Description

String path
Deprecated.

The dot separated path from the TemplateModel property to the value to apply encoding to.

- Element Detail
  - value
```
Class<? extends ModelEncoder<?,?>> value
```
    Deprecated.
    
    The ModelEncoder class to use for encoding the property found through {path().
    
    Returns:
    
    the ModelEncoder class
- - path
```
String path
```
    Deprecated.
    
    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:
    
    ""