org.dataloader.ValueCacheOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-dataloader Show documentation

A pure Java 8 port of Facebook Dataloader

There is a newer version: 2022-09-12T23-25-35-08559ba

package org.dataloader;

/**
 * Options that control how the {@link ValueCache} is used by {@link DataLoader}
 *
 * @author Brad Baker
 */
public class ValueCacheOptions {
    private final boolean completeValueAfterCacheSet;

    private ValueCacheOptions() {
        this.completeValueAfterCacheSet = false;
    }

    private ValueCacheOptions(boolean completeValueAfterCacheSet) {
        this.completeValueAfterCacheSet = completeValueAfterCacheSet;
    }

    public static ValueCacheOptions newOptions() {
        return new ValueCacheOptions();
    }

    /**
     * This controls whether the {@link DataLoader} will wait for the {@link ValueCache#set(Object, Object)} call
     * to complete before it completes the returned value.  By default this is false and hence
     * the {@link ValueCache#set(Object, Object)} call may complete some time AFTER the data loader
     * value has been returned.
     *
     * This is false by default, for performance reasons.
     *
     * @return true the {@link DataLoader} will wait for the {@link ValueCache#set(Object, Object)} call to complete before
     * it completes the returned value.
     */
    public boolean isCompleteValueAfterCacheSet() {
        return completeValueAfterCacheSet;
    }

    public ValueCacheOptions setCompleteValueAfterCacheSet(boolean flag) {
        return new ValueCacheOptions(flag);
    }

}