org.apache.camel.component.extension.verifier

Class ResultErrorHelper

java.lang.Object

org.apache.camel.component.extension.verifier.ResultErrorHelper

public final class ResultErrorHelper
extends Object

Helper that validates component parameters.

Method Summary

Modifier and Type	Method and Description
static List<ComponentVerifierExtension.VerificationError>	requiresAny(Map<String,Object> parameters, Collection<OptionsGroup> groups) Validates that the given parameters satisfy any grouped options (OptionsGroup).
static List<ComponentVerifierExtension.VerificationError>	requiresAny(Map<String,Object> parameters, OptionsGroup... groups) Validates that the given parameters satisfy any grouped options (OptionsGroup).
static Optional<ComponentVerifierExtension.VerificationError>	requiresOption(String parameterName, Map<String,Object> parameters)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

requiresOption

public static Optional<ComponentVerifierExtension.VerificationError> requiresOption(String parameterName,
                                                                                    Map<String,Object> parameters)

Parameters:

parameterName - the required option

parameters - the

Returns:

requiresAny

public static List<ComponentVerifierExtension.VerificationError> requiresAny(Map<String,Object> parameters,
                                                                             OptionsGroup... groups)

Validates that the given parameters satisfy any grouped options (OptionsGroup). A parameter set is valid if it is present and required by least one of the groups.

As an example consider that there are two option groups that can be specified:

• optionA: requires param1 and param2
• optionB: requires param1 and param3

Valid parameters are those that include param1 and either param2 and/or param3.

Note the special syntax of OptionsGroup.getOptions() that can require an property ("propertyName") or can forbid the presence of a property ("!propertyName").

With that if in the example above if param2 is specified specifying param3 is not allowed, and vice versa option groups should be defined with options:

• optionA: ["param1", "param2", "!param3"]
• optionB: ["param1", "!param2", "param3"]

Parameters:

parameters - given parameters of a component

groups - groups of options

See Also:

OptionsGroup

requiresAny

public static List<ComponentVerifierExtension.VerificationError> requiresAny(Map<String,Object> parameters,
                                                                             Collection<OptionsGroup> groups)

Validates that the given parameters satisfy any grouped options (OptionsGroup). A parameter set is valid if it is present and required by least one of the groups.

Parameters:

parameters - given parameters of a component

groups - groups of options

See Also:

requiresAny(Map, OptionsGroup...), OptionsGroup