io.nosqlbench.virtdata.api.ValuesArrayBinder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of virtdata-lib-curves4 Show documentation

Statistical sampling library for use in virtdata libraries, based on apache commons math 4

There is a newer version: 5.17.0

package io.nosqlbench.virtdata.api;

import io.nosqlbench.virtdata.api.templates.StringCompositor;

/**
 * ValuesArrayBinder provides a way to apply an array of object values to a template
 * object of type T to yield a new object instance of type R. The object array is
 * a positional argument list. There is no named-argument facility.
 *
 * Parameter Examples:
 * 
 *     T: prepared Statement, R: bound statement
 *     T: string template, R: interpolated string value
 * 
 *
 * ValuesArrayBinders can either be created as helper types, to be passed in as
 * mapping functions to other calls, or they can be directly implemented in higher-order
 * types which include the ability to produce objects of type R from values provided.
 * Both types of use are found in this API. An example of the former type would be
 * {@link ContextualBindingsArrayTemplate},
 * while and example of the latter would
 * be {@link StringCompositor}.
 * be {@link StringCompositor}.
 * 
 *
 * @param  The template type
 * @param  The result type
 */
public interface ValuesArrayBinder {

    /**
     * Using context instance of type T, AKA the template, create and bind values to
     * target object of type R
     * @param context A context object that knows how to provide an instance of type R
     * @param values An array of values which should be bound to the new R instance
     * @return The new result instance of R
     */
    R bindValues(T context, Object[] values);
}