ValidationResultItem (Mule Artifact AST 1.1.0-20221117 API)

All Known Implementing Classes:

DefaultValidationResultItem
```
@NoImplement
public interface ValidationResultItem
```
Relates a failing validation to the component where that validation failed.

Since:

1.0

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static ValidationResultItem`	`create(ComponentAst component, ComponentParameterAst parameter, Validation validation, String message)`
`static ValidationResultItem`	`create(ComponentAst component, ComponentParameterAst parameter, Validation validation, String message, Map<String,String> additionalData)`
`static ValidationResultItem`	`create(ComponentAst component, List<ComponentParameterAst> parameters, Validation validation, String message)`
`static ValidationResultItem`	`create(ComponentAst component, List<ComponentParameterAst> parameters, Validation validation, String message, Map<String,String> additionalData)`
`static ValidationResultItem`	`create(ComponentAst component, Validation validation, String message)`
`static ValidationResultItem`	`create(List<ComponentAst> components, List<ComponentParameterAst> parameters, Validation validation, String message)`
`static ValidationResultItem`	`create(List<ComponentAst> components, List<ComponentParameterAst> parameters, Validation validation, String message, Map<String,String> additionalData)`
`static ValidationResultItem`	`create(List<ComponentAst> components, Validation validation, String message)`
`Map<String,String>`	`getAdditionalData()` Any additional data provided by the actual validation, providing context for this item (for instance, in the case of validation on parameter values, it may contain an entry indication in which character of the value the validation error was found).
`List<ComponentAst>`	`getComponents()`
`String`	`getMessage()`
`List<ComponentParameterAst>`	`getParameters()`
`Validation`	`getValidation()`

Method Detail

create

static ValidationResultItem create(ComponentAst component,
                                   Validation validation,
                                   String message)

Parameters:: component - the component this validation result applies to.; validation - the validation that failed.; message - the message explaining the reason of the validation failure.
Returns:: an object representing a validation failure.

create

static ValidationResultItem create(ComponentAst component,
                                   ComponentParameterAst parameter,
                                   Validation validation,
                                   String message)

Parameters:: component - the component this validation result applies to.; parameter - the parameter from the component this validation result applies to.; validation - the validation that failed.; message - the message explaining the reason of the validation failure.
Returns:: an object representing a validation failure.

create

static ValidationResultItem create(ComponentAst component,
                                   List<ComponentParameterAst> parameters,
                                   Validation validation,
                                   String message)

Parameters:: component - the component this validation result applies to.; parameters - the parameters from the component this validation result applies to.; validation - the validation that failed.; message - the message explaining the reason of the validation failure.
Returns:: an object representing a validation failure.

create

static ValidationResultItem create(ComponentAst component,
                                   ComponentParameterAst parameter,
                                   Validation validation,
                                   String message,
                                   Map<String,String> additionalData)

Parameters:: component - the component this validation result applies to.; parameter - the parameter from the component this validation result applies to.; validation - the validation that failed.; message - the message explaining the reason of the validation failure.; additionalData - additional data provided by the actual validation.
Returns:: an object representing a validation failure.

create

static ValidationResultItem create(ComponentAst component,
                                   List<ComponentParameterAst> parameters,
                                   Validation validation,
                                   String message,
                                   Map<String,String> additionalData)

Parameters:: component - the component this validation result applies to.; parameters - the parameters from the component this validation result applies to.; validation - the validation that failed.; message - the message explaining the reason of the validation failure.; additionalData - additional data provided by the actual validation.
Returns:: an object representing a validation failure.

create

static ValidationResultItem create(List<ComponentAst> components,
                                   Validation validation,
                                   String message)

Parameters:: components - the components this validation result applies to.; validation - the validation that failed.; message - the message explaining the reason of the validation failure.
Returns:: an object representing a validation failure.

create

static ValidationResultItem create(List<ComponentAst> components,
                                   List<ComponentParameterAst> parameters,
                                   Validation validation,
                                   String message)

Parameters:: components - the components this validation result applies to.; parameters - the parameters from the components this validation result applies to.; validation - the validation that failed.; message - the message explaining the reason of the validation failure.
Returns:: an object representing a validation failure.

create

static ValidationResultItem create(List<ComponentAst> components,
                                   List<ComponentParameterAst> parameters,
                                   Validation validation,
                                   String message,
                                   Map<String,String> additionalData)

Parameters:: components - the components this validation result applies to.; parameters - the parameters from the components this validation result applies to.; validation - the validation that failed.; message - the message explaining the reason of the validation failure.; additionalData - additional data provided by the actual validation.
Returns:: an object representing a validation failure.

getComponents
```
List<ComponentAst> getComponents()
```
Returns:

the components this validation result applies to.

getParameters
```
List<ComponentParameterAst> getParameters()
```
Returns:

the parameters from the components this validation result applies to.

getValidation
```
Validation getValidation()
```
Returns:

the validation that failed.

getMessage
```
String getMessage()
```
Returns:

the message explaining the reason of the validation failure.

getAdditionalData
```
Map<String,String> getAdditionalData()
```
Any additional data provided by the actual validation, providing context for this item (for instance, in the case of validation on parameter values, it may contain an entry indication in which character of the value the validation error was found).

Since:

1.1

Interface ValidationResultItem

Method Summary

Method Detail

create

create

create

create

create

create

create

create

getComponents

getParameters

getValidation

getMessage

getAdditionalData