org.instancio.settings.FeedDataAccess 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.settings;

import org.instancio.documentation.ExperimentalApi;
import org.instancio.feed.Feed;

/**
 * Specifies how {@link Feed} data is accessed.
 *
 * @see Keys#FEED_DATA_ACCESS
 * @since 5.0.0
 */
@ExperimentalApi
public enum FeedDataAccess {

    /**
     * Specifies that data should be accessed in random order.
     */
    RANDOM,

    /**
     * Specifies that data should be accessed in sequential order.
     *
     * If this mode is selected, consider setting
     * the {@link FeedDataEndAction}.
     *
     * @see Keys#FEED_DATA_END_ACTION
     */
    SEQUENTIAL
}