org.instancio.InstancioFeedApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of instancio-core Show documentation
The standalone module of Instancio
There is a newer version: 5.2.1
/*
 * Copyright 2022-2024 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.instancio;

import org.instancio.documentation.ExperimentalApi;
import org.instancio.feed.DataSourceProvider;
import org.instancio.feed.Feed;
import org.instancio.feed.FormatOptionsProvider;
import org.instancio.settings.FeedDataAccess;
import org.instancio.settings.FeedDataEndAction;
import org.instancio.settings.FeedFormatType;
import org.instancio.settings.SettingKey;
import org.instancio.settings.Settings;

/**
 * An API for customising the properties of a {@link Feed}.
 *
 * @param  the type of feed
 * @since 5.0.0
 */
@ExperimentalApi
public interface InstancioFeedApi extends
        FeedApi,
        SettingsApi {

    /**
     * Creates an instance of the feed.
     *
     * @return an instance of the feed
     * @since 5.0.0
     */
    @ExperimentalApi
    F create();

    /**
     * Specifies the data source for a {@link Feed}, for example:
     *
     * {@code
     * SampleFeed feed = Instancio.ofFeed(SampleFeed.class)
     *     .withDataSource(source -> source.ofResource("data/sample.csv"))
     *     .create();
     * }
     *
     * @param provider of the data source
     * @return API builder reference
     * @see Feed.Source
     * @since 5.0.0
     */
    @ExperimentalApi
    InstancioFeedApi withDataSource(DataSourceProvider provider);

    /**
     * {@inheritDoc}
     *
     * @since 5.0.0
     */
    @Override
    @ExperimentalApi
    InstancioFeedApi formatOptions(FormatOptionsProvider provider);

    /**
     * {@inheritDoc}
     *
     * @since 5.0.0
     */
    @Override
    @ExperimentalApi
    InstancioFeedApi formatType(FeedFormatType feedFormatType);

    /**
     * {@inheritDoc}
     *
     * @since 5.0.0
     */
    @Override
    @ExperimentalApi
    InstancioFeedApi withTagKey(String tagKey);

    /**
     * {@inheritDoc}
     *
     * @since 5.0.0
     */
    @Override
    @ExperimentalApi
    InstancioFeedApi withTagValue(String tagValue);

    /**
     * {@inheritDoc}
     *
     * @since 5.0.0
     */
    @Override
    InstancioFeedApi dataAccess(FeedDataAccess feedDataAccess);

    /**
     * {@inheritDoc}
     *
     * @since 5.0.0
     */
    @Override
    InstancioFeedApi onDataEnd(FeedDataEndAction feedDataEndAction);

    /**
     * {@inheritDoc}
     *
     * @since 5.0.0
     */
    @Override
    @ExperimentalApi
     InstancioFeedApi withSetting(SettingKey key, V value);

    /**
     * {@inheritDoc}
     *
     * @since 5.0.0
     */
    @Override
    @ExperimentalApi
    InstancioFeedApi withSettings(Settings settings);
}