blob: 04c753d912e5b99fe345361380dbad4f0043dae1 [file] [log] [blame] [view]
---
layout: default
title: ConversionErrorFieldValidator Annotation
parent:
title: Annotations
url: annotations.html
---
# ConversionErrorFieldValidator Annotation
This validator checks if there are any conversion errors for a field and applies them if they exist.
See [Type Conversion Error Handling](type-conversion.html#type-conversion-error-handling) for details.
## Usage
The `ConversionErrorFieldValidator` annotation must be applied at method level.
## Parameters
<p> <table class='confluenceTable' summary=''>
<tr>
<th class='confluenceTh'> Parameter </th>
<th class='confluenceTh'> Required </th>
<th class='confluenceTh'> Default </th>
<th class='confluenceTh'> Notes </th>
</tr>
<tr>
<td class='confluenceTd'>message</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'>field error message</td>
</tr>
<tr>
<td class='confluenceTd'>key</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'>i18n key from language specific properties file.</td>
</tr>
<tr>
<td class='confluenceTd'>messageParams</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'>Additional params to be used to customize message - will be evaluated against the Value Stack</td>
</tr>
<tr>
<td class='confluenceTd'>fieldName</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'>shortCircuit</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>false</td>
<td class='confluenceTd'>If this validator should be used as shortCircuit.</td>
</tr>
<tr>
<td class='confluenceTd'>type</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>ValidatorType.FIELD</td>
<td class='confluenceTd'>Enum value from ValidatorType. Either FIELD or SIMPLE can be used here.</td>
</tr>
</table>
</p>
## Examples
```java
@ConversionErrorFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true)
```