diffusion/src/data/record/record-builder.js

Diffusion JavaScript client

var _interface = require('util/interface')._interface;

/**
 * Builds free format {@link diffusion.datatypes.RecordV2 RecordV2 value}.
 * <P>
 * This type of builder may be used to generate free format
 * {@link diffusion.datatypes.RecordV2} format data which is not constrained by a
 * {@link diffusion.datatypes.RecordV2.Schema}.
 * <P>
 * Such a builder can be created using {@link diffusion.datatypes.RecordV2DataType#valueBuilder()}.
 *
 * @class diffusion.datatypes.RecordV2.RecordV2Builder
 * @since 6.0
 */
module.exports = _interface('RecordV2Builder', [
    /**
     * Adds one or more field values.
     * <P>
     * If there is a current record, this adds the fields to the end of the
     * current record.
     *
     * @param {Array<String>} values - field values
     * @return {diffusion.datatypes.RecordV2.RecordV2Builder} this builder
     * @function diffusion.datatypes.RecordV2.RecordV2Builder#addFields
     */
    'addFields',

    /**
     * Adds a new record comprising the specified field values.
     *
     * @param {Array<String>} fields - the fields within the new record. If no fields are
     *        supplied, an empty record will be added.
     *
     * @return {diffusion.datatypes.RecordV2.RecordV2Builder} this builder
     * @function diffusion.datatypes.RecordV2.RecordV2Builder#addRecord
     */
    'addRecord',

    /**
     * Clears all current values from the builder allowing it to be reused to
     * generate new data.
     *
     * @return {diffusion.datatypes.RecordV2.RecordV2Builder} this builder
     * @function diffusion.datatypes.RecordV2.RecordV2Builder#clear
     */
    'clear',

    /**
     * Builds a {@link diffusion.datatypes.RecordV2} object from the current builder state.
     *
     * @return a new {@link diffusion.datatypes.RecordV2} object.
     * @function diffusion.datatypes.RecordV2.RecordV2Builder#build
     */
    'build'
]);