com.univocity.api.config.annotation
Annotation Type FunctionWrapper


@Retention(value=RUNTIME)
@Inherited
@Target(value=METHOD)
public @interface FunctionWrapper

A function wrapper is used to annotate methods of classes whose instances are used by a DataIntegrationEngine to wrap methods in a FunctionCall.

Important: Methods with this annotation must declare a return value. Arrays of objects are supported.

Author:
uniVocity Software Pty Ltd - dev@univocity.com
See Also:
FunctionCall, EngineScope, DataIntegrationEngine

Optional Element Summary
 String name
          The name of the function call used in expressions and mappings of a DataIntegrationEngine.
 EngineScope scope
          The EngineScope of the FunctionCall created with this method.
 

name

public abstract String name
The name of the function call used in expressions and mappings of a DataIntegrationEngine. If no explicit name is provided, then the method name will be used.

Returns:
the name of the function to be used in place of the method name
Default:
""

scope

public abstract EngineScope scope
The EngineScope of the FunctionCall created with this method. It determines how the result produced by this call is retained before the function has to be called again. A new function call with the same parameters (if any) will be executed only once in each active scope.

Note: functions are accessible from any scope.

Returns:
the scope associated with values returned by this function.
Default:
com.univocity.api.engine.EngineScope.STATELESS


Copyright © 2015 uniVocity Software Pty Ltd. All rights reserved.